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

Consider making it clearer that --verbose is an option for the help subcommand itself #103

Open
scotje opened this issue Jun 18, 2019 · 4 comments

Comments

@scotje
Copy link

scotje commented Jun 18, 2019

When using the basic help command, the way the --verbose option is currently presented can be a bit confusing for users:

$ mycommand help new

<snip>

OPTIONS FOR NEW
    -d --debug                     Enable debug output.
    -h --help                      Show help for this command.
    -v --verbose                   show more detailed help
       --version                   Show version of mycommand.

It would be clearer if --verbose was listed in it's own section labelled OPTIONS FOR HELP or something similar:

$ mycommand help new

<snip>

OPTIONS FOR NEW
    -d --debug                     Enable debug output.
    -h --help                      Show help for this command.

OPTIONS FOR HELP
    -v --verbose                   show more detailed help
@scotje scotje changed the title Make it clearer that --verbose is an option for the help subcommand itself Consider making it clearer that --verbose is an option for the help subcommand itself Jun 18, 2019
@denisdefreyne
Copy link
Owner

Hey,

Which version of Cri does this happen in? 2.15.8 had a bug in it, which was rectified in 2.15.9 (see release notes).

I can’t reproduce the problem locally; do you have a test case?

@scotje
Copy link
Author

scotje commented Jun 19, 2019

Let me check again with 2.15.9 and see if I can still replicate the issue.

@scotje
Copy link
Author

scotje commented Jun 19, 2019

Yeah it looks like 2.15.9 resolves this. Is it expected then that the --verbose option is only ever listed in the (1 hidden command omitted; show it with --verbose) text that shows up when you hide something?

@denisdefreyne
Copy link
Owner

Is it expected then that the --verbose option is only ever listed in the (1 hidden command omitted; show it with --verbose) text that shows up when you hide something?

I don't quite understand what you mean. Can you rephrase? The --verbose option should always be visible in the help text.

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

No branches or pull requests

2 participants