Replies: 2 comments 7 replies
-
Semantically, describing an arg is a
I would say it's an issue for docs.rs because they don't search the description of the items IIRC. |
Beta Was this translation helpful? Give feedback.
7 replies
-
@CreepySkeleton and @Dylan-DPC any thoughts? |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
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
Beta Was this translation helpful? Give feedback.
All reactions