Skip to content

Commit 15d3b6f

Browse files
Jenkinsopenstack-gerrit
authored andcommitted
Merge "Fix 'code-block' tag format issues"
2 parents 2ae7072 + c832e2a commit 15d3b6f

2 files changed

Lines changed: 17 additions & 15 deletions

File tree

doc/source/command-options.rst

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ prepended (such as in the traditional GNU option usage) like `--share` and
2727
In order to handle those APIs that behave differently when a field is set to
2828
`None` and when the field is not present in a passed argument list or dict,
2929
each of the boolean options shall set its own variable to `True` as part of
30-
a mutiually exclusive group, rather than the more common configuration of setting a
31-
single destination variable `True` or `False` directly. This allows us to
32-
detect the situation when neither option is present (both variables will be
33-
`False`) and act accordingly for those APIs where this matters.
30+
a mutiually exclusive group, rather than the more common configuration of
31+
setting a single destination variable `True` or `False` directly. This allows
32+
us to detect the situation when neither option is present (both variables will
33+
be `False`) and act accordingly for those APIs where this matters.
3434

3535
This also requires that each of the boolean values be tested in the
3636
`take_action()` method to correctly set (or not) the underlying API field
@@ -47,9 +47,9 @@ values.
4747
Implementation
4848
~~~~~~~~~~~~~~
4949

50-
The parser declaration should look like this::
50+
The parser declaration should look like this:
5151

52-
.. code-block: python
52+
.. code-block:: python
5353
5454
enable_group = parser.add_mutually_exclusive_group()
5555
enable_group.add_argument(
@@ -63,7 +63,9 @@ The parser declaration should look like this::
6363
help=_('Disable <resource>'),
6464
)
6565
66-
An example handler in `take_action()`::
66+
An example handler in `take_action()`:
67+
68+
.. code-block:: python
6769
6870
# This leaves 'enabled' undefined if neither option is present
6971
if parsed_args.enable:
@@ -88,9 +90,9 @@ commands should allow `--long` even if they return all fields by default.
8890
Implementation
8991
~~~~~~~~~~~~~~
9092

91-
The parser declaration should look like this::
93+
The parser declaration should look like this:
9294

93-
.. code-block: python
95+
.. code-block:: python
9496
9597
parser.add_argument(
9698
'--long',
@@ -102,9 +104,9 @@ The parser declaration should look like this::
102104
Pagination
103105
----------
104106

105-
There are many ways to do pagination, some OpenStack APIs support it, some don't.
106-
OpenStackClient attempts to define a single common way to specify pagination on
107-
the command line.
107+
There are many ways to do pagination, some OpenStack APIs support it, some
108+
don't. OpenStackClient attempts to define a single common way to specify
109+
pagination on the command line.
108110

109111
.. option:: --marker <marker>
110112

@@ -117,9 +119,9 @@ the command line.
117119
Implementation
118120
~~~~~~~~~~~~~~
119121

120-
The parser declaration should look like this::
122+
The parser declaration should look like this:
121123

122-
.. code-block: python
124+
.. code-block:: python
123125
124126
parser.add_argument(
125127
"--marker",

doc/source/command-wrappers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ deprecation message as a warning to the user then calls the original class.
3434
Example Deprecation Class
3535
-------------------------
3636

37-
.. code-block: python
37+
.. code-block:: python
3838
3939
class ListFooOld(ListFoo):
4040
"""List resources"""

0 commit comments

Comments
 (0)