clarification

bcdev · Feb 21, 2025 · 0711ccd · 0711ccd
1 parent dc1a95d
commit 0711ccd
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/docs/cli.md b/docs/cli.md
@@ -49,7 +49,8 @@ Options:
   --color / --no-color    Force enabling/disabling of color
   --max-warnings COUNT    Number of warnings to trigger nonzero exit code -
                           default: 5
-  --init                  Write initial configuration file and exit.
+  --init                  Write initial configuration file 'xrlint-
+                          config.yaml' and exit.
   --version               Show the version and exit.
   --help                  Show this message and exit.
 

diff --git a/xrlint/cli/main.py b/xrlint/cli/main.py
@@ -11,6 +11,7 @@
 from xrlint.cli.constants import (
     DEFAULT_MAX_WARNINGS,
     DEFAULT_OUTPUT_FORMAT,
+    DEFAULT_CONFIG_FILE_YAML,
 )
 from xrlint.version import version
 
@@ -90,7 +91,7 @@
 @click.option(
     "--init",
     "init_mode",
-    help="Write initial configuration file and exit.",
+    help=f"Write initial configuration file '{DEFAULT_CONFIG_FILE_YAML}' and exit.",
     is_flag=True,
 )
 @click.argument("files", nargs=-1)