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

Improve the --help message to indicate subcommands also have help info #282

Open
bskinn opened this issue Jul 6, 2023 · 0 comments
Open
Labels
area: cli 💻 issue: planned ⌚ Assigned to a specific version's milestone type: enhancement ✨ Something to add
Milestone

Comments

@bskinn
Copy link
Owner

bskinn commented Jul 6, 2023

Small change to highlight to users that subcommand help is also available:


Originally posted by @pawamoy in #279 (comment):

I generally print something like this myself:

usage: griffe [GLOBAL_OPTS...] COMMAND [COMMAND_OPTS...]

Signatures for entire Python programs.

Global options:
  -h, --help  Show this help message and exit. Commands also accept the -h/--help option.

Commands:
  COMMAND
    dump      Load package-signatures and dump them as JSON.
    check     Check for API breakages or possible improvements.

Not sure if it's more visible 🤷

@bskinn bskinn added type: enhancement ✨ Something to add issue: planned ⌚ Assigned to a specific version's milestone area: cli 💻 labels Jul 6, 2023
@bskinn bskinn added this to the Post-2.3.1 milestone Jul 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: cli 💻 issue: planned ⌚ Assigned to a specific version's milestone type: enhancement ✨ Something to add
Projects
None yet
Development

No branches or pull requests

1 participant