Arg::hide_short_help

hide_short_help

since 0.1.0

Hides an argument from short help (-h).

Examples

Example 1

Spec

TOML

name = "prog"
[args]
cfg = { long = "config", hide-short-help = true, help = "Some help text describing the --config arg" }

YAML

name: prog
args:
  cfg:
    long: config
    hide-short-help: true
    help: Some help text describing the --config arg

JSON

{
  "name": "prog",
  "args": {
    "cfg": {
      "long": "config",
      "hide-short-help": true,
      "help": "Some help text describing the --config arg"
    }
  }
}

Input

prog -h

Output

Usage: prog [OPTIONS]

Options:
  -h, --help  Print help (see more with '--help')

Example 2

Spec

TOML

name = "prog"
[args]
cfg = { long = "config", hide-short-help = true, help = "Some help text describing the --config arg" }

YAML

name: prog
args:
  cfg:
    long: config
    hide-short-help: true
    help: Some help text describing the --config arg

JSON

{
  "name": "prog",
  "args": {
    "cfg": {
      "long": "config",
      "hide-short-help": true,
      "help": "Some help text describing the --config arg"
    }
  }
}

Input

prog --help

Output

Usage: prog [OPTIONS]

Options:
      --config <cfg>
          Some help text describing the --config arg

  -h, --help
          Print help (see a summary with '-h')