openstack/python-zunclient
Code Issues Proposed changes

Fix python-openstackclient plugin doc build

Browse Source 
Some plugin command option help strings contained '|' characters which
sphinx misinterpreted as substitution reference markers, causing
building autoprogram-cliff from python-openstackclient to break with
errors like:

.../python-openstackclient/doc/source/cli/plugin-commands/zun.rst:124:Inline substitution_reference start-string without end-string.

This commit reformats the help strings to use double backticks, which
build properly.

Change-Id: Ia3fd6d5ec76e0e6d6aee87d8a8790a1ed2d38a26
This commit is contained in:
Eric Fried
2019-10-22 14:13:20 -05:00
parent bc1cfd9737
commit ca2b5fe6a8
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
zunclient/osc/v1/containers.py
View File

@@ -201,10 +201,10 @@ class CreateContainer(command.ShowOne):
help='Specify a test cmd to perform to check that the container'
'is healthy. '
'cmd: Command to run to check health. '
'interval: Time between running the check (|s|m|h)'
'interval: Time between running the check (``s|m|h``)'
' (default 0s). '
'retries: Consecutive failures needed to report unhealthy.'
'timeout: Maximum time to allow one check to run (s|m|h)'
'timeout: Maximum time to allow one check to run (``s|m|h``)'
' (default 0s).')
parser.add_argument(
'--wait',
@@ -891,10 +891,10 @@ class RunContainer(command.ShowOne):
help='Specify a test cmd to perform to check that the container'
'is healthy. '
'cmd: Command to run to check health. '
'interval: Time between running the check (s|m|h)'
'interval: Time between running the check (``s|m|h``)'
' (default 0s). '
'retries: Consecutive failures needed to report unhealthy.'
'timeout: Maximum time to allow one check to run (s|m|h)'
'timeout: Maximum time to allow one check to run (``s|m|h``)'
' (default 0s).')
parser.add_argument(
'--wait',