fix(help): Don't commit to '--help' that doesn't work #3169
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
We have two ways of fixing this - Making `--help` work - Don't put `--help` in the help output For now, I went with the latter. I tried to make it clear what the actual requirement is so we can pivot if needed. Fixes clap-rs#2892 This happens to also fix the interaction of `DisableHelpFlag` with the help subcommand and complcations. I've added a test to help catch if we break this by changing how we fixed the original issue. Fixes clap-rs#2724 These issues were reported against clap3. I've not tried to reproduce these in clap2 to see if they should show up in the release notes.
pksunkara
approved these changes
Dec 13, 2021
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.
We have two ways of fixing this
--helpwork--helpin the help outputFor now, I went with the latter. I tried to make it clear what the
actual requirement is so we can pivot if needed.
Fixes #2892
This happens to also fix the interaction of
DisableHelpFlagwith thehelp subcommand and complcations. I've added a test to help catch if we
break this by changing how we fixed the original issue.
Fixes #2724
These issues were reported against clap3. I've not tried to reproduce
these in clap2 to see if they should show up in the release notes.