gh-132558: Improve argparse docs on combining type and choices
#133827
+8
−4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
argparse docs on combining type and choices
Doc/library/argparse.rst
Outdated
Comment on lines
1130
to
1133
| Formatted choices override the default *metavar* which is normally derived | ||
| from *dest*. This is usually what you want because the user never sees the | ||
| *dest* parameter. If this display isn't desirable (perhaps because there are | ||
| many choices), just specify an explicit metavar_. |
There was a problem hiding this comment.
This should not be inbetween the choices notes.
There was a problem hiding this comment.
It was already with the choices documentation. Where would you move it to?
There was a problem hiding this comment.
You should move the text you added above it.
Doc/library/argparse.rst
Outdated
Comment on lines
1141
to
1142
| Use of :class:`enum.Enum` is not recommended because it is difficult to | ||
| control its appearance in these messages. |
There was a problem hiding this comment.
I think it's previous place was fine, it continued naturally from the previous point.
Co-authored-by: Savannah Bailey <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This clarifies the documentation a bit to warn users of the potential side effects of using both
typeandchoiceson an action. It also suggests that it is better in those cases to do type conversion in application code.choiceswithtype#132558📚 Documentation preview 📚: https://cpython-previews--133827.org.readthedocs.build/