fix help hint showing shadowed option name#3208
Merged
Rowlando13 merged 3 commits intoApr 29, 2026
Merged
Conversation
b981ca9 to
10841e5
Compare
Collaborator
|
I just reworked that PR to be more resilient against various cases of default option names overriding. Also added unittests to illustrate all these edge-cases. |
Fix pallets#2790. Co-authored-by: Mr-Neutr0n <64578610+Mr-Neutr0n@users.noreply.github.com>
10841e5 to
1241aba
Compare
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.
3 participants
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.
Fixes #2790.
When a subcommand defines an option that shadows one of the configured help option names (e.g.
-h), the error hint was still suggesting the shadowed name:But
-his now the subcommand's--hostoption, not help. Runningcli foo -hgivesError: Option '-h' requires an argument.instead of showing help.The fix uses
get_help_option_names()which already exists and filters out names claimed by other parameters. So now the hint picks a working alternative like--help: