Arg::value_names

value_names

since 0.1.0

Placeholders for the argument’s values in the help message / usage.

Example

Spec

TOML

name = "prog"
[args]
io = { long = "io-files", value-names = ["INFILE", "OUTFILE"] }

YAML

name: prog
args:
  io:
    long: io-files
    value-names:
    - INFILE
    - OUTFILE

JSON

{
  "name": "prog",
  "args": {
    "io": {
      "long": "io-files",
      "value-names": [
        "INFILE",
        "OUTFILE"
      ]
    }
  }
}

Input

prog --help

Output

Usage: prog [OPTIONS]

Options:
      --io-files <INFILE> <OUTFILE>
  -h, --help                         Print help