gh-132558: Improve argparse docs on combining type and choices
#133827
Conversation
argparse docs on combining type and choices
Doc/library/argparse.rst
Outdated
| 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
| 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 <savannahostrowski@gmail.com>
|
|
||
| To keep *choices* user-friendly, consider a custom type wrapper that | ||
| converts and formats values, or omit type_ and handle conversion in | ||
| your application code. |
There was a problem hiding this comment.
| your application code. | |
| your application code. | |
|
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 And if you don't make the requested changes, you will be put in the comfy chair! |
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/