Closed joshfrench closed 4 months ago
@dearchap I'm stalled at the following test error:
# 🚨 ---> Hey! <---
# The unified diff above indicates that the public API surface area
# has changed. If you feel that the changes are acceptable for the
# v3.x series, please run the following command to promote the
# current go docs:
#
# make v3approve
Should I run that and get the tests passing, or would you like to review the changes first? Thanks!
@joshfrench Yes the changes look good for the most part. Can you run make v3approve and push ?
@dearchap pushed!
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 own
Category
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