Skip to content

docs: fix parameter names showing as None in CLI usage docs #2671

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: fix parameter names showing as None in CLI usage docs #2671

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion tools/docs/gen_cli_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,16 @@ def main(docs_dir):

for action in sorted(p._actions, key=lambda a: a.dest):
if action.required:
required.append((action.dest, ([action.metavar], action.help)))
# Fall back to dest-derived name if metavar is not explicitly set,
# matching argparse's own behaviour: positional args use dest,
# optional args use dest.upper().
if action.metavar is not None:
metavar = action.metavar
elif action.option_strings:
metavar = action.dest.upper()
else:
metavar = action.dest
required.append((action.dest, ([metavar], action.help)))
elif action.option_strings and action.dest not in global_options:
options[action.dest] = (action.option_strings, action.help)

Expand Down