Skip to content

Commit

Permalink
docs: add deprecate to documentation (#1762)
Browse files Browse the repository at this point in the history
  • Loading branch information
natasha-audrey committed Sep 22, 2020
1 parent e1a300f commit 5fd5251
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/api.md
Expand Up @@ -1191,6 +1191,7 @@ Valid `opt` keys include:
- `default`: value, set a default value for the option, see [`default()`](#default)
- `defaultDescription`: string, use this description for the default value in help content, see [`default()`](#default)
- `demandOption`: boolean or string, demand the option be given, with optional error message, see [`demandOption()`](#demandOption)
- `deprecate`/`deprecated`: boolean or string, mark option as deprecated, see [`deprecateOption()`](#deprecateOption)
- `desc`/`describe`/`description`: string, the option description for help content, see [`describe()`](#describe)
- `global`: boolean, indicate that this key should not be [reset](#reset) when a command is invoked, see [`global()`](#global)
- `group`: string, when displaying usage instructions place the option under an alternative group heading, see [`group()`](#group)
Expand Down

0 comments on commit 5fd5251

Please sign in to comment.