honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update boolean and enumerated CLI section (#40224) 

With this change we change the `Boolean and enumerated options` to use kebab-case flags
 as the camelCase variant are deprecated. We also remove the `enumerated option description`
 as this is no longer correct and needed following the CLI MAN page update in #40038

PR Close #40224
This commit is contained in:
Alan Agius 2020-12-21 17:59:09 +01:00 committed by Joey Perrott
parent 53b64fb659
commit e54261b8d8
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
aio/content/cli/index.md
View File

@ -93,12 +93,11 @@ Command syntax is shown as follows:
[camelCase or dash-case](guide/glossary#case-types). [camelCase or dash-case](guide/glossary#case-types).
`--myOptionName` is equivalent to `--my-option-name`. `--myOptionName` is equivalent to `--my-option-name`.
### Boolean and enumerated options ### Boolean options
Boolean options have two forms: `--thisOption` sets the flag, `--noThisOption` clears it. Boolean options have two forms: `--this-option` sets the flag to `true`, `--no-this-option` sets it to `false`.
If neither option is supplied, the flag remains in its default state, as listed in the reference documentation. If neither option is supplied, the flag remains in its default state, as listed in the reference documentation.
Allowed values are given with each enumerated option description, with the default value in **bold**.
### Relative paths ### Relative paths