openstack
/
python-troveclient
Code Issues Proposed changes

Fix python-openstackclient plugin doc build 

Some plugin command option help strings were using invalid syntax to
refer to another option. This looked odd in CLI output

  --marker <ID>         Begin displaying the results for IDs greater than
                        thespecified marker. When used with :option:`--limit,`
                        setthis to the last ID displayed in the previous run.

and also caused building autoprogram-cliff from python-openstackclient
to break with errors like:

<ListDatabaseInstances>:1:unknown option: --limit,

This commit reformats the help strings to use double backticks, which
render sanely in the CLI help and also build properly from
python-openstackclient.

Change-Id: Ia3fd6d5ec76e0e6d6aee87d8a8790a1ed2d38a26
This commit is contained in:
Eric Fried 2019-10-22 14:02:44 -05:00
parent 960843de81
commit 5f0271a735
3 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
troveclient/osc/v1/database_backups.py
View File

@ -51,7 +51,7 @@ class ListDatabaseBackups(command.Lister):
type=str,
default=None,
help=_('Begin displaying the results for IDs greater than the'
'specified marker. When used with :option:`--limit,` set'
'specified marker. When used with ``--limit``, set '
'this to the last ID displayed in the previous run.')
)
parser.add_argument(
@ -123,7 +123,7 @@ class ListDatabaseInstanceBackups(command.Lister):
type=str,
default=None,
help=_('Begin displaying the results for IDs greater than the'
'specified marker. When used with :option:`--limit,` set'
'specified marker. When used with ``--limit``, set '
'this to the last ID displayed in the previous run.')
)
return parser

2
troveclient/osc/v1/database_clusters.py
View File

@ -67,7 +67,7 @@ class ListDatabaseClusters(command.Lister):
type=str,
default=None,
help=_('Begin displaying the results for IDs greater than the'
' specified marker. When used with :option:`--limit,` set'
' specified marker. When used with ``--limit``, set '
' this to the last ID displayed in the previous run.')
)
return parser

2
troveclient/osc/v1/database_instances.py
View File

@ -97,7 +97,7 @@ class ListDatabaseInstances(command.Lister):
type=str,
default=None,
help=_('Begin displaying the results for IDs greater than the'
'specified marker. When used with :option:`--limit,` set'
'specified marker. When used with ``--limit``, set '
'this to the last ID displayed in the previous run.')
)
parser.add_argument(