From 79dc6e18bc0b2c638e71b8e5bccefea2ccd3027d Mon Sep 17 00:00:00 2001 From: Nathan Yocum Date: Mon, 21 Sep 2020 14:00:25 -0700 Subject: [PATCH 1/2] Update docs to include deprecate --- docs/api.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/api.md b/docs/api.md index 96fb0304b..b1b674d40 100644 --- a/docs/api.md +++ b/docs/api.md @@ -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`: 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) From 28ad43f060898554019a7130dc4e30c38ccf8202 Mon Sep 17 00:00:00 2001 From: Nathan Yocum Date: Mon, 21 Sep 2020 14:13:40 -0700 Subject: [PATCH 2/2] Include deprecated too --- docs/api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api.md b/docs/api.md index b1b674d40..95e9fa582 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1191,7 +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`: boolean or string, mark option as deprecated, see [`deprecateOption()`](#deprecateOption) +- `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)