fix: Default values for CLI arguments not aligned with documentation.

Fixes #2642 Signed-off-by: Frost Ming <[email protected]>
pdm-project · Feb 26, 2024 · aa2ed00 · aa2ed00
1 parent 0ae5611
commit aa2ed00
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/docs/docs/reference/cli.md b/docs/docs/reference/cli.md
@@ -53,7 +53,10 @@ def render_parser(
                 line += f" `{action.metavar}`"
             line += f": {clean_help(action.help)}"
             if action.default and action.default != argparse.SUPPRESS:
-                line += f" (default: `{action.default}`)"
+                default = action.default
+                if any(opt.startswith("--no-") for opt in action.option_strings) and default is True:
+                    default = not default
+                line += f" (default: `{default}`)"
             result.append(line)
         result.append("")
 

diff --git a/news/2642.doc.md b/news/2642.doc.md
@@ -0,0 +1 @@
+Fix the default value for negative CLI flags.