diff options
| author | Atsushi SAKAI <sakaia@jp.fujitsu.com> | 2016-08-25 19:48:13 +0900 |
|---|---|---|
| committer | Atsushi SAKAI <sakaia@jp.fujitsu.com> | 2016-08-25 19:54:24 +0900 |
| commit | c97e8187fef91627a1c55236a45eb5b1b8d92fc2 (patch) | |
| tree | dc111a6bb239eec6749cfc9dfb8f33137d57f627 /doc/source/command-options.rst | |
| parent | 3f86cc0d80228d80c7e3b866c60abedaa58fbbd4 (diff) | |
| download | python-openstackclient-c97e8187fef91627a1c55236a45eb5b1b8d92fc2.tar.gz | |
Fix six typos
disassoiate => disassociate
nmaes => names
mutiually => mutually
aviod => avoid
CLustering => Clustering
availble => available
Change-Id: I84545bf46acfccc9dde3e85020700edb5a8375a6
Diffstat (limited to 'doc/source/command-options.rst')
| -rw-r--r-- | doc/source/command-options.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/source/command-options.rst b/doc/source/command-options.rst index ebfeb5aa..a833d1d5 100644 --- a/doc/source/command-options.rst +++ b/doc/source/command-options.rst @@ -17,7 +17,7 @@ new command without understanding why or why not that instance is correct. The :doc:`Human Interface Guide <humaninterfaceguide>` describes the guildelines for option names and usage. In short: * All option names shall be GNU-style long names (two leading dashes). - * Some global options may have short nmaes, generally limited to those defined + * Some global options may have short names, generally limited to those defined in support libraries such as ``cliff``. General Command Options @@ -36,7 +36,7 @@ prepended (such as in the traditional GNU option usage) like `--share` and In order to handle those APIs that behave differently when a field is set to `None` and when the field is not present in a passed argument list or dict, each of the boolean options shall set its own variable to `True` as part of -a mutiually exclusive group, rather than the more common configuration of +a mutually exclusive group, rather than the more common configuration of setting a single destination variable `True` or `False` directly. This allows us to detect the situation when neither option is present (both variables will be `False`) and act accordingly for those APIs where this matters. @@ -218,7 +218,7 @@ Some options have no default value and the API does not allow them to be `None`, then these options are always required when users use the command to which these options belong. -Required options must be validated by the CLI to aviod omissions. The CLI +Required options must be validated by the CLI to avoid omissions. The CLI validation may provide an error message for the user if a required option is not specified. (for example: ``error: argument --test is required``) |