Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add deprecate to documentation #1762

Merged
merged 3 commits into from Sep 22, 2020
Merged

docs: add deprecate to documentation #1762

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
79dc6e1
Update docs to include deprecate
natasha-audrey Sep 21, 2020
28ad43f
Include deprecated too
natasha-audrey Sep 21, 2020
ffae14b
Merge branch 'master' into docs/Add-Deprecate-To-Docs
bcoe Sep 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/api.md
View file
Open in desktop
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