From 5fd525175de85e9409d2a3d3b905c334e80ec15c Mon Sep 17 00:00:00 2001 From: Nathan Yocum Date: Tue, 22 Sep 2020 11:52:32 -0700 Subject: [PATCH] docs: add deprecate to documentation (#1762) --- docs/api.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/api.md b/docs/api.md index 96fb0304b..95e9fa582 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`/`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)