Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make UseLongFormatForHelpSubcommand unconditionally on #3440

Closed
epage opened this issue Feb 10, 2022 · 1 comment · Fixed by #3451
Closed

Make UseLongFormatForHelpSubcommand unconditionally on #3440

epage opened this issue Feb 10, 2022 · 1 comment · Fixed by #3451
Labels
A-help Area: documentation, including docs.rs, readme, examples, etc... C-bug Category: Updating dependencies E-easy Call for participation: Experience needed to fix: Easy / not much M-breaking-change Meta: Implementing or merging this will introduce a breaking change.
Milestone
4.0

Comments

@epage
Copy link
Member

epage commented Feb 10, 2022

As a user, when I see help I think of --help and would expect it to be the same output.

I also think is important to err on the side of more information, than less.
@epage epage added M-breaking-change Meta: Implementing or merging this will introduce a breaking change. A-help Area: documentation, including docs.rs, readme, examples, etc... E-easy Call for participation: Experience needed to fix: Easy / not much labels Feb 10, 2022
@epage epage added this to the 4.0 milestone Feb 10, 2022
@epage epage added the C-bug Category: Updating dependencies label Feb 10, 2022
@epage epage mentioned this issue Feb 10, 2022
Closed
@epage
Copy link
Member Author

epage commented Feb 11, 2022

See #2435 for the issue that led to this attribute being added.

epage added a commit to epage/clap that referenced this issue Feb 11, 2022
@epage
fix(help): Subcommand help looks like --help
0fc83e4 
Like was said in clap-rs#2435, this is what people would expect.

While we should note this in a compatibility section in the changelog, I
do not consider this a breaking change since we should be free to adjust
the help output as needed.  We are cautious when people might build up
their own content around it (like clap-rs#3312) but apps should already handle
this with `--help` so this shouldn't be a major change.

We aren't offering a way for people to disable this, assuming people
won't need to.  Longer term, we are looking at support "Actions" (clap-rs#3405)
and expect those to help customize the flags.  We'll need something
similar for the `help` subcommand.

Fixes clap-rs#3440
epage added a commit to epage/clap that referenced this issue Feb 11, 2022
@epage
fix(help): Subcommand help looks like --help
06d43a0 
Like was said in clap-rs#2435, this is what people would expect.

While we should note this in a compatibility section in the changelog, I
do not consider this a breaking change since we should be free to adjust
the help output as needed.  We are cautious when people might build up
their own content around it (like clap-rs#3312) but apps should already handle
this with `--help` so this shouldn't be a major change.

We aren't offering a way for people to disable this, assuming people
won't need to.  Longer term, we are looking at support "Actions" (clap-rs#3405)
and expect those to help customize the flags.  We'll need something
similar for the `help` subcommand.

Fixes clap-rs#3440
@epage epage mentioned this issue Feb 11, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-help Area: documentation, including docs.rs, readme, examples, etc... C-bug Category: Updating dependencies E-easy Call for participation: Experience needed to fix: Easy / not much M-breaking-change Meta: Implementing or merging this will introduce a breaking change.
Projects
None yet
Milestone
4.0
Development

Successfully merging a pull request may close this issue.

fix(help): Subcommand help looks like --help epage/clap
1 participant
@epage