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

Regression in wrapping help #2170

Closed
pksunkara opened this issue Oct 13, 2020 · 2 comments · Fixed by #2174
Closed

Regression in wrapping help #2170

pksunkara opened this issue Oct 13, 2020 · 2 comments · Fixed by #2174
Labels
A-help Area: documentation, including docs.rs, readme, examples, etc... C-bug Category: Updating dependencies
Milestone

Comments

@pksunkara
Copy link
Member

When you have a small terminal width, your code has wrap_help feature enabled, and you have args of which some have about very small so that the arg can fit in the terminal width and other args whose about is big such that they would be wrapped, we get the following:

Actual Behavior Summary

cargo-workspaces-version 
Bump version of crates

USAGE:
    cargo workspaces version [FLAGS]

FLAGS:
    -a, --all
            Also do versioning for private crates (will not be published)

        --exact
            Specify inter dependency version numbers exactly with `=`

    -h, --help                   Prints help information
        --no-git-commit          Do not commit version changes
        --no-git-push
            Do not push generated commit and tags to git remote

Expected Behavior Summary

The display should be consistent.

cargo-workspaces-version 
Bump version of crates

USAGE:
    cargo workspaces version [FLAGS]

FLAGS:
    -a, --all
            Also do versioning for private crates (will not be published)

        --exact
            Specify inter dependency version numbers exactly with `=`

    -h, --help
            Prints help information

        --no-git-commit
            Do not commit version changes

        --no-git-push
            Do not push generated commit and tags to git remote

Additional context

This needs to be consistent per section. If all the args can fit inside the wrapped width, then we can just do one line. If not, then all of them should be in the new line format.

@pksunkara pksunkara added C-bug Category: Updating dependencies A-help Area: documentation, including docs.rs, readme, examples, etc... labels Oct 13, 2020
@pksunkara pksunkara added this to the 3.0 milestone Oct 13, 2020
@pksunkara
Copy link
Member Author

@ldm0 Would you like to take this? Should be easy enough.

@ldm0
Copy link
Member

ldm0 commented Oct 13, 2020

No problem.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-help Area: documentation, including docs.rs, readme, examples, etc... C-bug Category: Updating dependencies
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants