search

bskinn / sphobjinv

Toolkit for manipulation and inspection of Sphinx objects.inv files
https://sphobjinv.readthedocs.io
MIT License
79 stars 9 forks source link

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

Open bskinn opened 1 year ago

bskinn commented 1 year ago

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

Originally posted by @pawamoy in https://github.com/bskinn/sphobjinv/issues/279#issuecomment-1423141961:

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 :shrug: