diff options
| author | Stephen Finucane <sfinucan@redhat.com> | 2017-03-20 16:19:27 +0000 |
|---|---|---|
| committer | Stephen Finucane <sfinucan@redhat.com> | 2017-03-28 16:41:54 +0100 |
| commit | 70170656fd4d3c8020391354b13dca63e9e024d1 (patch) | |
| tree | c9ba08521eba6a19c44cf50d1e6d7756f22ba65e /doc/source/command-options.rst | |
| parent | 9f471eede95b7c555c4b71673806bd11943460e0 (diff) | |
| download | python-openstackclient-70170656fd4d3c8020391354b13dca63e9e024d1.tar.gz | |
doc: Correct Sphinx warnings
- Fix option-describe typos
- Correct option and envvar markup, for commands that are using the
reference form instead of the definition form or are marking up
option arguments as options
- Avoid duplicate commands
- Fix some invalid docstrings
- Fix some invalid indentation
- Disable the murano plugin, which has invalid docs
- Correct issues with- and track the network-topology spec
- Include API modules in docs
Change-Id: I3d5ed5e872540fe13f3e4bd5e9335829dc9a5226
Diffstat (limited to 'doc/source/command-options.rst')
| -rw-r--r-- | doc/source/command-options.rst | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/source/command-options.rst b/doc/source/command-options.rst index faa82bee..8d1d1c4e 100644 --- a/doc/source/command-options.rst +++ b/doc/source/command-options.rst @@ -16,9 +16,10 @@ 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 names, generally limited to those defined - in support libraries such as ``cliff``. + +* All option names shall be GNU-style long names (two leading dashes). +* Some global options may have short names, generally limited to those defined + in support libraries such as ``cliff``. General Command Options ======================= |