From e54261b8d88df99d2d1a0850c8bddc2633bf9725 Mon Sep 17 00:00:00 2001 From: Alan Agius Date: Mon, 21 Dec 2020 17:59:09 +0100 Subject: [PATCH] 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 --- aio/content/cli/index.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/aio/content/cli/index.md b/aio/content/cli/index.md index ea587fd890..c350846d97 100644 --- a/aio/content/cli/index.md +++ b/aio/content/cli/index.md @@ -93,12 +93,11 @@ Command syntax is shown as follows: [camelCase or dash-case](guide/glossary#case-types). `--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. -Allowed values are given with each enumerated option description, with the default value in **bold**. ### Relative paths