Skip to content

Commit 317959d

Browse files
Jenkinsopenstack-gerrit
authored andcommitted
Merge "Fix yet more documentation warnings"
2 parents 4d9d2db + d70df6a commit 317959d

6 files changed

Lines changed: 14 additions & 13 deletions

File tree

doc/source/command-objects/endpoint.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Create new endpoint
4848
.. code:: bash
4949
5050
os endpoint create
51-
[--region <region-id>
51+
[--region <region-id>]
5252
[--enable | --disable]
5353
<service>
5454
<interface>

doc/source/command-objects/image.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ Set image properties
246246
247247
Disk format of image.
248248
Acceptable formats: ['ami', 'ari', 'aki', 'vhd', 'vmdk', 'raw', 'qcow2',
249-
'vdi', 'iso']
249+
'vdi', 'iso']
250250
251251
.. option:: --size <size>
252252
@@ -330,7 +330,7 @@ image add project
330330
331331
Associate project with image
332332
333-
.. progran:: image add project
333+
.. program:: image add project
334334
.. code:: bash
335335
336336
os image add project
@@ -357,7 +357,7 @@ image remove project
357357
358358
Disassociate project with image
359359
360-
.. progran:: image remove project
360+
.. program:: image remove project
361361
.. code:: bash
362362
363363
os image remove remove

doc/source/command-objects/keypair.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ keypair create
1212

1313
Create new public key
1414

15-
.. program keypair create
15+
.. program:: keypair create
1616
.. code:: bash
1717
1818
os keypair create
@@ -32,7 +32,7 @@ keypair delete
3232

3333
Delete public key
3434

35-
.. program keypair delete
35+
.. program:: keypair delete
3636
.. code:: bash
3737
3838
os keypair delete
@@ -47,7 +47,7 @@ keypair list
4747

4848
List public key fingerprints
4949

50-
.. program keypair list
50+
.. program:: keypair list
5151
.. code:: bash
5252
5353
os keypair list
@@ -57,7 +57,7 @@ keypair show
5757

5858
Display public key details
5959

60-
.. program keypair show
60+
.. program:: keypair show
6161
.. code:: bash
6262
6363
os keypair show

doc/source/command-objects/project.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,12 @@ Delete project(s)
7070
.. code:: bash
7171
7272
os project delete
73+
[--domain <domain>]
7374
<project> [<project> ...]
7475
7576
.. option:: --domain <domain>
7677

77-
Domain owning :ref:`\<project\> <_project_delete-project>` (name or ID)
78+
Domain owning :ref:`\<project\> <project_delete-project>` (name or ID)
7879

7980
.. versionadded:: 3
8081

doc/source/command-objects/user.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,16 +83,16 @@ Delete user(s)
8383
.. code:: bash
8484
8585
os user delete
86+
[--domain <domain>]
8687
<user> [<user> ...]
8788
8889
.. option:: --domain <domain>
8990
90-
Domain owning :ref:`\<user\> <_user_delete-user>` (name or ID)
91+
Domain owning :ref:`\<user\> <user_delete-user>` (name or ID)
9192
9293
.. versionadded:: 3
9394
9495
.. _user_delete-user:
95-
9696
.. describe:: <user>
9797
9898
User to delete (name or ID)

doc/source/releases.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ Release Notes
100100
Bug `1446751 <https://bugs.launchpad.net/bugs/1446751>`_
101101

102102
* Document the backward-compatibility-breaking changes in
103-
:doc:`backwards-incompatibile`.
103+
:doc:`backwards-incompatible`.
104104
Bug `1406470 <https://bugs.launchpad.net/bugs/1406470>`_
105105

106106
* Add `--parent`` option to `projct create` command.
@@ -203,7 +203,7 @@ Release Notes
203203

204204
* Set a default domain ID when both ``OS_USER_DOMAIN_ID`` and
205205
``OS_USER_DOMAIN_NAME`` are not set. This is also done for
206-
``OS_PROJECT_DOMAIN_ID`` and ``OS_PROJECT_DOMAIN_NAME`.
206+
``OS_PROJECT_DOMAIN_ID`` and ``OS_PROJECT_DOMAIN_NAME``.
207207
(*Identity API v3 only*).
208208
Bug `1385338 <https://bugs.launchpad.net/bugs/1385338>`_: Improve domain related defaults when using v3 identity
209209

0 commit comments

Comments
 (0)