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

Display visible aliases on the next line when they'd significantly widen display #526

Closed
joshtriplett opened this issue Jun 10, 2016 · 3 comments
Labels
A-help Area: documentation, including docs.rs, readme, examples, etc...
Milestone

Comments

@joshtriplett
Copy link
Contributor

Visible aliases for subcommands (from #522) can significantly widen the help display, and move subcommand descriptions far away from the subcommand name, making it harder to pair them up. For example:

    log                          Show the history of the patch series
    pull-request|request-pull    Generate a mail requesting a pull of the patch series

Please consider an alternate format that doesn't widen the display like this. For instance, indent a bit and put the aliases underneath the main subcommand name:

    log             Show the history of the patch series
    pull-request    Generate a mail requesting a pull of the patch series
      Alias: request-pull

Or with more than one alias:

    log             Show the history of the patch series
    pull-request    Generate a mail requesting a pull of the patch series
      Aliases: req, request-pull
@kbknapp
Copy link
Member

kbknapp commented Jun 10, 2016

Very true. What about formatting them as such:

    log             Show the history of the patch series
    pull-request    Generate a mail requesting a pull of the patch series [aliases: req, request-pull]

To my eye, the newline and extra indent looks off...but that's also subjective 😜

The other option I thought about was:

    log             Show the history of the patch series
    pull-request    Generate a mail requesting a pull of the patch series
    req             Alias for 'pull-request'
    request-pull    Alias for 'pull-request'

@kbknapp kbknapp added T: RFC / question A-help Area: documentation, including docs.rs, readme, examples, etc... labels Jun 10, 2016
@joshtriplett
Copy link
Contributor Author

joshtriplett commented Jun 10, 2016

@kbknapp
Either of those looks good to me.

@kbknapp
Copy link
Member

kbknapp commented Jun 13, 2016

This is fixed with #530

Edit: I went with the [aliases: one, two, three] method as it was the least refactoring and still looks good to my eye.

@kbknapp kbknapp added this to the 2.6.0 milestone Jun 13, 2016
@homu homu closed this as completed in ca511de Jun 13, 2016
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...
Projects
None yet
Development

No branches or pull requests

2 participants