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/backwards-incompatible.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/backwards-incompatible.rst')
| -rw-r--r-- | doc/source/backwards-incompatible.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/source/backwards-incompatible.rst b/doc/source/backwards-incompatible.rst index 4f38aa54..54f29bc3 100644 --- a/doc/source/backwards-incompatible.rst +++ b/doc/source/backwards-incompatible.rst @@ -46,7 +46,7 @@ Releases Before 3.0 2. <type> should not be optional for command `openstack service create` Previously, the command was `openstack service create <name> --type <type>`, - whereas now it is: `openstack service create <type> --name <name>` + whereas now it is: `openstack service create <type> --name <name>`. This bug also affected python-keystoneclient, and keystone. * In favor of: making <type> a positional argument. @@ -170,12 +170,12 @@ Releases Before 3.0 * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065 * Commit: https://review.openstack.org/#/c/281088/ -12. <version> <url> <md5hash> should be optional for command `openstack compute agent set` +12. `<version> <url> <md5hash>` should be optional for command `openstack + compute agent set` - Previously, the command was `openstack compute agent set <id> <version> <url> <md5hash>`, - whereas now it is: `openstack compute agent set <id> --version <version> - --url <url> - --md5hash <md5hash>`. + Previously, the command was `openstack compute agent set <id> <version> <url> + <md5hash>`, whereas now it is: `openstack compute agent set <id> --version + <version> --url <url> --md5hash <md5hash>`. * In favor of: making <version> <url> <md5hash> optional. * As of: NA |