-
-
Notifications
You must be signed in to change notification settings - Fork 33.2k
gh-59330: Improve error message for dest= for positionals #125215
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.
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
gh-59330: Improve error message for dest= for positionals #125215
Conversation
Also improve the documentation. Specify how dest and metavar are derived from add_argument() positional arguments. Co-authored-by: Simon Law <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just one small comment about the documentation; otherwise, this LGTM!
I really like the additional error message specificity.
| By default, argparse automatically handles the internal naming and | ||
| display names of arguments, simplifying the process without requiring | ||
| additional configuration. | ||
| As such, you do not need to specify the dest_ and metavar_ parameters. | ||
| The dest_ parameter defaults to the argument name with underscores ``_`` | ||
| replacing hyphens ``-`` . The metavar_ parameter defaults to the | ||
| upper-cased name. For example:: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| By default, argparse automatically handles the internal naming and | |
| display names of arguments, simplifying the process without requiring | |
| additional configuration. | |
| As such, you do not need to specify the dest_ and metavar_ parameters. | |
| The dest_ parameter defaults to the argument name with underscores ``_`` | |
| replacing hyphens ``-`` . The metavar_ parameter defaults to the | |
| upper-cased name. For example:: | |
| By default, argparse automatically handles the internal naming and | |
| display names of arguments, simplifying the process without requiring | |
| additional configuration. As such, you do not need to specify the dest_ | |
| and metavar_ parameters. The dest_ parameter defaults to the argument | |
| name with underscores ``_`` replacing hyphens ``-`` . The metavar_ | |
| parameter defaults to the upper-cased name. For example:: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just removing the newline as I think that this can be one short paragraph.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This does not affect the result. For Sphinx this is the same.
I prefer to start new sentence from a new line. This will help to keep the text more readable in future without reformatting the whole paragraph. Adding or removing will only affect one sentence.
I don't know if this is already in the style guide, but I try to follow this rule.
| PROG: error: the following arguments are required: bar | ||
|
|
||
| By default, argparse automatically handles the internal naming and | ||
| display names of arguments, simplifying the process without requiring |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@serhiy-storchaka , of arguments or of non-positional arguments?
https://stackoverflow.com/a/20250435/556958
Also improve the documentation. Specify how dest and metavar are derived from add_argument() positional arguments.
📚 Documentation preview 📚: https://cpython-previews--125215.org.readthedocs.build/