openstack/python-openstackclient
Code Issues Proposed changes

Fix yet more documentation warnings

Browse Source 
Change-Id: I87683039601ae90531f27ebebbc4d0b1d252e846
This commit is contained in:
TerryHowe 2015-07-21 14:07:18 -06:00
parent 4c368d12d2
commit d70df6a4a2
6 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/command-objects/endpoint.rst
View File

@ -48,7 +48,7 @@ Create new endpoint
.. code:: bash .. code:: bash
os endpoint create os endpoint create
[--region <region-id> [--region <region-id>]
[--enable | --disable] [--enable | --disable]
<service> <service>
<interface> <interface>

6
doc/source/command-objects/image.rst
View File

@ -246,7 +246,7 @@ Set image properties
Disk format of image. Disk format of image.
Acceptable formats: ['ami', 'ari', 'aki', 'vhd', 'vmdk', 'raw', 'qcow2', Acceptable formats: ['ami', 'ari', 'aki', 'vhd', 'vmdk', 'raw', 'qcow2',
'vdi', 'iso'] 'vdi', 'iso']
.. option:: --size <size> .. option:: --size <size>
@ -330,7 +330,7 @@ image add project
Associate project with image Associate project with image
.. progran:: image add project .. program:: image add project
.. code:: bash .. code:: bash
os image add project os image add project
@ -357,7 +357,7 @@ image remove project
Disassociate project with image Disassociate project with image
.. progran:: image remove project .. program:: image remove project
.. code:: bash .. code:: bash
os image remove remove os image remove remove

8
doc/source/command-objects/keypair.rst
View File

@ -12,7 +12,7 @@ keypair create
Create new public key Create new public key
.. program keypair create .. program:: keypair create
.. code:: bash .. code:: bash
os keypair create os keypair create
@ -32,7 +32,7 @@ keypair delete
Delete public key Delete public key
.. program keypair delete .. program:: keypair delete
.. code:: bash .. code:: bash
os keypair delete os keypair delete
@ -47,7 +47,7 @@ keypair list
List public key fingerprints List public key fingerprints
.. program keypair list .. program:: keypair list
.. code:: bash .. code:: bash
os keypair list os keypair list
@ -57,7 +57,7 @@ keypair show
Display public key details Display public key details
.. program keypair show .. program:: keypair show
.. code:: bash .. code:: bash
os keypair show os keypair show

3
doc/source/command-objects/project.rst
View File

@ -70,11 +70,12 @@ Delete project(s)
.. code:: bash .. code:: bash
os project delete os project delete
[--domain <domain>]
<project> [<project> ...] <project> [<project> ...]
.. option:: --domain <domain> .. option:: --domain <domain>
Domain owning :ref:`\<project\> <_project_delete-project>` (name or ID) Domain owning :ref:`\<project\> <project_delete-project>` (name or ID)
.. versionadded:: 3 .. versionadded:: 3

4
doc/source/command-objects/user.rst
View File

@ -83,16 +83,16 @@ Delete user(s)
.. code:: bash .. code:: bash
os user delete os user delete
[--domain <domain>]
<user> [<user> ...] <user> [<user> ...]
.. option:: --domain <domain> .. option:: --domain <domain>
Domain owning :ref:`\<user\> <_user_delete-user>` (name or ID) Domain owning :ref:`\<user\> <user_delete-user>` (name or ID)
.. versionadded:: 3 .. versionadded:: 3
.. _user_delete-user: .. _user_delete-user:
.. describe:: <user> .. describe:: <user>
User to delete (name or ID) User to delete (name or ID)

4
doc/source/releases.rst
View File

@ -100,7 +100,7 @@ Release Notes
Bug `1446751 <https://bugs.launchpad.net/bugs/1446751>`_ Bug `1446751 <https://bugs.launchpad.net/bugs/1446751>`_
* Document the backward-compatibility-breaking changes in * Document the backward-compatibility-breaking changes in
:doc:`backwards-incompatibile`. :doc:`backwards-incompatible`.
Bug `1406470 <https://bugs.launchpad.net/bugs/1406470>`_ Bug `1406470 <https://bugs.launchpad.net/bugs/1406470>`_
* Add `--parent`` option to `projct create` command. * Add `--parent`` option to `projct create` command.
@ -203,7 +203,7 @@ Release Notes
* Set a default domain ID when both ``OS_USER_DOMAIN_ID`` and * Set a default domain ID when both ``OS_USER_DOMAIN_ID`` and
``OS_USER_DOMAIN_NAME`` are not set. This is also done for ``OS_USER_DOMAIN_NAME`` are not set. This is also done for
``OS_PROJECT_DOMAIN_ID`` and ``OS_PROJECT_DOMAIN_NAME`. ``OS_PROJECT_DOMAIN_ID`` and ``OS_PROJECT_DOMAIN_NAME``.
(*Identity API v3 only*). (*Identity API v3 only*).
Bug `1385338 <https://bugs.launchpad.net/bugs/1385338>`_: Improve domain related defaults when using v3 identity Bug `1385338 <https://bugs.launchpad.net/bugs/1385338>`_: Improve domain related defaults when using v3 identity