Uh oh!
There was an error while loading. Please reload this page.
gh-58247: clarify metavar behaviour in ArgumentParser.add_subparsers - #148671
gh-58247: clarify metavar behaviour in ArgumentParser.add_subparsers#148671SofieTorch wants to merge 2 commits into
Conversation
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
| is ``None`` and presents subcommands in form {cmd1, cmd2, ..} | ||
| is ``None`` and presents subcommands in form {cmd1, cmd2, ..} in the usage line | ||
| and next to the subparsers group heading. It does not change how the | ||
| individual subcommands are listed below that heading |
There was a problem hiding this comment.
I'd suggest using the same format as the description for dest. Maybe something like the following will keep it more concise (argparse docs are already quite long 😅 ):
* metavar_ - placeholder shown in the usage line and in the help entry for the subparsers argument
in place of {cmd1, cmd2, ..}; by default ``None``
This wasn't something you changed but technically speaking, metavar actually replaces the list of subcommands, it doesn't present it.
savannahostrowski
commented
Jun 5, 2026
Hey @SofieTorch, still up for finishing this one? Happy to chat more too! |
Documents how
metavararg affects the --help output in subparsers.Related to issue #58247
📚 Documentation preview 📚: https://cpython-previews--148671.org.readthedocs.build/