You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Jan 1, 2022. It is now read-only.
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 the Arg table of contents, but it wasn't there until beta.5 and its deprecated (Issue: clap-rs/clap#1823, PR: clap-rs/clap#1840). So in a way, clap-rs/clap#2718 has been helping but its of limited time until the next major release.
We have conflicting needs:
We want consistency within clap so its easier to move from one piece to another (the old Arg::help is analogous to App::about)
We want to be clear in our terms (does help refer to just a help description or the entire help, especially a problem in App)
We want to be discoverable
Which about hasn't been for me
In terms of past clap users, "do nothing" is discoverable
In terms of past structopt users, they don't care since they use doc comments :)
In terms of what people might be familiar with:
python's argparse's equivalent is App::description and Arg::help
golang's kong's equivalent is App::description and Arg::help
This reverts commits 24cb8b1..d0abb37 from clap-rs/clap#1840
This is part of #16. clap-rs/clap#1840 wasn't the right call but we
don't have time to make the decision now, so instead of having one
option and changing it in 4.0, this reverts back to clap2 behavior.
This reverts commits 24cb8b1..d0abb37 from clap-rs/clap#1840
This is part of #16. clap-rs/clap#1840 wasn't the right call but we
don't have time to make the decision now, so instead of having one
option and changing it in 4.0, this reverts back to clap2 behavior.
This reverts commits 24cb8b1..d0abb37 from clap-rs/clap#1840
This is part of #16. clap-rs/clap#1840 wasn't the right call but we
don't have time to make the decision now, so instead of having one
option and changing it in 4.0, this reverts back to clap2 behavior.
epage
changed the title
Arg::about is unexpected, causing me to miss it when trying to look up the docs for what to tuseArg::about is unexpected, causing me to miss it when trying to look up the docs for what to use
Nov 29, 2021
epage
changed the title
Arg::about is unexpected, causing me to miss it when trying to look up the docs for what to useApp::about and Arg::help are inconsistent
Dec 3, 2021
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.
We have
App::about
,Arg::help
andPossibleValue::help
.Should these be more consistent?
See a prior discussion for more context
Original Issue after #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: clap-rs/clap#1823, PR: clap-rs/clap#1840). So in a way, clap-rs/clap#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 clap-rs/clap#2164
The text was updated successfully, but these errors were encountered: