Arg::help

help

since 0.1.0

Sets the description of the argument for short help (-h).

Example

Spec

TOML

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

YAML

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

JSON

{
  "name": "prog",
  "args": {
    "cfg": {
      "long": "config",
      "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