fix: Show possible values in generated man file #4082
Merged
Conversation
This file contains 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
Calder-Ty
changed the title
epage
reviewed
Aug 16, 2022
Calder-Ty
force-pushed
the
bugfix/3861
branch
3 times, most recently
from
890245f to
8308815
Compare
|
Appologies for the wait getting back on this feedback. The noted changes should be reflected in the latest updates |
epage
reviewed
Aug 20, 2022
This adds feature parity for mangen with the standard help output. Users will now see the list of possible values for value arguments. One change that was made to make this possible was adding the method `get_possible_values` to the public API for an arg. I tried to think of a way to get around this, but because this is the interface that the help generation uses, and it is part of the crate public interface I thing adding it as a part of the public API might be for the best. fixes: clap-rs#3861
This makes sure we take into account the setting that possible args is hidden
Noticed that possible values would not show up for Positional arguments as well. Decided to add the changes for those as well.
|
Thanks! This was made against master which is v4. If you would like, you are welcome to cherry-pick this onto v3-master. |
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 adds feature parity for mangen with the standard help output. Users
will now see the list of possible values for value arguments.
One change that was made to make this possible was adding the method
get_possible_valuesto the public API for an arg. I tried to think ofa way to get around this, but because this is the interface that the
help generation uses, and it is part of the crate public interface
I thing adding it as a part of the public API might be for the best.
If that is not the best option, please let me know and i can go back and look at it.
fixes: #3861