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

Allow customising of "extra" help #427

Open
donaldpipowitch opened this issue Mar 10, 2016 · 3 comments
Open

Allow customising of "extra" help #427

donaldpipowitch opened this issue Mar 10, 2016 · 3 comments

Comments

@donaldpipowitch
Copy link

When I use certain things like choices or default values the outputted help looks quite convoluted to me. It would be nice to optionally hide that output of format it differently.

E.g. I have this:

Options:
  -l, --log-level  Set log level
      [choices: "silly", "verbose", "info", "warn", "error", "silent"] [default:
                                                                         "info"]
  -v, --version    Show version number                                 [boolean]
  -h, --help       Show help                                           [boolean]

Maybe something like this is nicer:

Options:
  -l, --log-level  Set log level (default: "info")
                   [ "silly", "verbose", "info", "warn", "error", "silent" ]
  -v, --version    Show version number                                 [boolean]
  -h, --help       Show help                                           [boolean]
Options:
  -l, --log-level  Set log level (defaults to "info" or use "silly", "verbose", "warn", "error", "silent")
  -v, --version    Show version number                                 [boolean]
  -h, --help       Show help                                           [boolean]
Options:
  -l, --log-level  Set log level (defaults to "info")
  -v, --version    Show version number                                 [boolean]
  -h, --help       Show help                                           [boolean]
Options:
  -l, --log-level  Set log level (info,silly,verbose,warn,error,silent)
  -v, --version    Show version number                                 [boolean]
  -h, --help       Show help                                           [boolean]
@lrlna
Copy link
Member

lrlna commented Mar 10, 2016

@donaldpipowitch I am really liking your suggestions! A more readable version is always 💯 for me.

This could work as a verbose version for our help output, for sure.

@KohPoll
Copy link

KohPoll commented Jul 25, 2016

+1

@skygragon
Copy link

exactly, the choices line is too long to read, why not break them into different lines to make our eyes feel better?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants