Fix metavar for Choice options when show_choices=False#2365
Merged
Conversation
03a23b6 to
8b9ae77
Compare
|
Could it be shown without the square brackets if there is only one type choice? |
Member
Choices are always in brackets regardless of number. |
I noticed that, was merely making a suggestion. In my personal opinion, I feel for type choices (not literal choices), it would look better without the brackets. |
Member
|
But in my personal opinion it's more consistent to always use brackets, so we're at a stalemate, and I get to break the stalemate. 😉 |
Contributor
Author
|
I also prefer consistency. Reverting formatting change. |
d42be38 to
f7d98fe
Compare
Collaborator
|
@mrmups thanks for the fix. Our apologies that it took this long! ❤️ |
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The
show_choicesparameter is intended to suppress choices from being displayed inline whenclick.prompt()is used. It's available toclick.option()because an option can act like a prompt if theprompt=Trueparameter is used. However, this parameter does not prevent the choices from being used to create theChoicemetavar displayed within the--helpmessage.This change addresses this issue by creating the metavar string using the ParamTypes of the choices instead of the values themselves.
Example script:
Output when
show_choices=True:$ demoecho --help Usage: demoecho [OPTIONS] Options: -s, --string [hello|world] This value echoed back to stdout. --help Show this message and exit.Output when
show_choices=False:show_choices=Falseseems to have no effect #2356Checklist:
CHANGES.rstsummarizing the change and linking to the issue... versionchanged::entries in any relevant code docs.pre-commithooks and fix any issues.pytestandtox, no tests failed.