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

fix(help): Shorten --help short help to shorten short help #4408

Closed
wants to merge 2 commits into from
Closed

fix(help): Shorten --help short help to shorten short help #4408

wants to merge 2 commits into from

Commits on Oct 20, 2022

  1. fix(help): Use single quotes in -h/--help help 

    Use single quotes around the strings `-h` and `--help` in help output.
This is more consistent and improves readability a bit.
    @bgilbert
    bgilbert committed Oct 20, 2022
    Configuration menu
    Copy the full SHA
    905c876 View commit details
    Browse the repository at this point in the history

  2. fix(help): Shorten --help help to shorten help 

    Applications may want to constrain their short help to use the two-column
format so the -h output is as compact as possible.  They might do this by
optimizing short help texts to fit within the right-hand column on
80-character terminals, and then providing long help texts with more info.
However, c1c269b made the short help text for -h/--help much longer
when the short and long help are different, forcing short help to wrap to
the multiple-line format if medium-sized option/value names are used.

Reword the short help for this case to be as compact as possible.  The
net length is still a few characters longer than in clap 3, but this still
substantially increases the maximum width of the left column while
continuing to document the difference between -h and --help.

Fixes #4409
    @bgilbert
    bgilbert committed Oct 20, 2022
    Configuration menu
    Copy the full SHA
    ec70e35 View commit details
    Browse the repository at this point in the history