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.

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

docs: Update multiline usage override rules #4267

Merged
merged 1 commit into from Sep 27, 2022

Conversation

jpgrayson
Copy link
Contributor

The styling of usage has changed in #4188 such that the usage string is on the same line as the "Usage:" title. Previously, the usage went on the line below the title. As such, the rules have changed for how to make a multiline usage format correctly.

These updated rules achieve the following output for the documented example:

Usage: myapp -X [-a] [-b] <file>
       myapp -Y [-c] <file1> <file2>
       myapp -Z [-d|-e]

Relates-to: #4132

The styling of usage has changed in clap-rs#4188 such that the usage string is on
the same line as the "Usage:" title. Previously, the usage went on the line
below the title. As such, the rules have changed for how to make a
multiline usage format correctly.

These updated rules achieve the following output for the documented
example:

    Usage: myapp -X [-a] [-b] <file>
           myapp -Y [-c] <file1> <file2>
           myapp -Z [-d|-e]

Relates-to: clap-rs#4132
@epage
Copy link
Member

epage commented Sep 27, 2022

Thanks! Sorry that I had missed this when making the change!

@epage epage merged commit c7dd03e into clap-rs:master Sep 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants