App::about
and Arg::help
are inconsistent
#3075
Labels
A-builder
Area: Builder API
C-enhancement
Category: Raise on the bar on expectations
M-breaking-change
Meta: Implementing or merging this will introduce a breaking change.
S-waiting-on-decision
Status: Waiting on a go/no-go before implementing
We have
App::about
,Arg::help
andPossibleValue::help
.Should these be more consistent?
See a prior discussion for more context
Original Issue after epage/clapng#17
Transfered from clap-rs
When a user "knows" what they are looking for, they browse directly to it. As a user with clap3, when I'm looking to set the help description for an argument, I'm looking for
help
something in theArg
table of contents, but it wasn't there until beta.5 and its deprecated (Issue: #1823, PR: #1840). So in a way, #2718 has been helping but its of limited time until the next major release.We have conflicting needs:
Arg::help
is analogous toApp::about
)help
refer to just a help description or the entire help, especially a problem inApp
)about
hasn't been for meApp::description
andArg::help
App::description
andArg::help
Arg::description
Arg::help
The question is what do we prioritize and how should we resolve this?
I figured a discussion would be more appropriate rather than trying to lump this in with #2164
The text was updated successfully, but these errors were encountered: