Include mutually exclusive flags in help text #1863
Merged
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.
What type of PR is this?
What this PR does / why we need it:
The default help text did not include mutually exclusive flags; now it does:
Changes:
SetCategory
method added to Flag interface.Category
field andpropagateCategory
method added toMutuallyExclusiveFlags
, allowing mutex group to set a category and propagate it downward to all flags within.cmd.Flags
withcmd.allFlags()
when calculating visible flags and visible flag categories, to ensure downward-propagated group categories are included in help text.Which issue(s) this PR fixes:
Fixes #1858
Special notes for your reviewer:
I considered two approaches, described in #1858 . This is the simpler of the two, where no attempt is made to display or categorize mutually exclusive flags in any special way. Under this approach the changes are minimal and
users don't need to consider any special cases when using mutually exclusive flags.Flags within a mutex group now ignore their ownCategory
and inherit it from the group instead, but there's precedent with the mutex group'sRequired
field so it's not an entirely new concept.Testing
Unit tests are updated to reflect both uncategorized and categorized output.
Release Notes