Skip to content

Commit 6bb6d2f

Browse files
committed
minor readme improvements
1 parent 56b4bde commit 6bb6d2f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -202,12 +202,12 @@ command and subcommands (under the `commands` definition).
202202
`short` | An additional, optional pattern - usually used to denote a one letter variation of the command name. You can add `*` as a suffix, to denote a "starts with" pattern - for example `short: m*`. *Applicable only in subcommands*.
203203
`help` | The header text to display when using `--help`. This option can have multiple lines. In this case, the first line will be used as summary wherever appropriate.
204204
`version` | The string to display when using `--version`. *Applicable only in the main command*.
205-
`default` | Setting this to `true` on any command, will make unrecognized command line arguments to be passed to this command. *Applicable only in subcommands*.
205+
`default` | Setting this to `true` on any command, will cause any unrecognized command line to be passed to this command. *Applicable only in subcommands*.
206206
`examples` | Specify an array of examples to show when using `--help`. Each example can have multiple lines.
207-
`environment_variables` | Specify an array of environment variables needed by your script.
208-
`commands` | Specify the array of commands. Each command will have its own args and flags. Note: if `commands` is provided, you cannot specify flags or args at the same level.
209-
`args` | Specify the array of positional arguments this script needs.
210-
`flags` | Specify the array of option flags this script needs.
207+
`environment_variables` | Specify an array of [environment variables](#environment-variable-options) needed by your script.
208+
`commands` | Specify the array of [commands](#command-options). Each command will have its own args and flags. Note: if `commands` is provided, you cannot specify flags or args at the same level.
209+
`args` | Specify the array of [positional arguments](#argument-options) this script needs.
210+
`flags` | Specify the array of option [flags](#flag-options) this script needs.
211211
`catch_all` | Specify that this command should allow for additional arbitrary arguments or flags. It can be set in one of three ways:<br>- Set to `true` to just enable it.<br>- Set to a string, to use this string in the usage help text.<br>- Set to a hash containing `label` and `help` keys, to show a detailed help for it when running with `--help`.
212212
`dependencies` | Specify an array of any required external dependencies (commands). The script execution will be halted with a friendly error unless all dependency commands exist.
213213
`group` | In case you have many commands, use this option to specify a caption to display before this command. This option is purely for display purposes, and needs to be specified only for the first command in each group.

0 commit comments

Comments
 (0)