diff options
| author | Eric Fried <openstack@fried.cc> | 2019-10-22 14:02:44 -0500 |
|---|---|---|
| committer | Eric Fried <openstack@fried.cc> | 2019-10-22 14:08:10 -0500 |
| commit | 5f0271a735516d9c9b30a730fecf4738bafa6cde (patch) | |
| tree | 1fd3c75893d0da466d6363acf8369524e329abb4 | |
| parent | 960843de8142db6e61cc4d148a51f55862acbba0 (diff) | |
| download | python-troveclient-3.1.0.tar.gz | |
Fix python-openstackclient plugin doc build3.1.0
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
| -rw-r--r-- | troveclient/osc/v1/database_backups.py | 4 | ||||
| -rw-r--r-- | troveclient/osc/v1/database_clusters.py | 2 | ||||
| -rw-r--r-- | troveclient/osc/v1/database_instances.py | 2 |
3 files changed, 4 insertions, 4 deletions
diff --git a/troveclient/osc/v1/database_backups.py b/troveclient/osc/v1/database_backups.py index 1088a6a..53e19fc 100644 --- a/troveclient/osc/v1/database_backups.py +++ b/troveclient/osc/v1/database_backups.py @@ -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 diff --git a/troveclient/osc/v1/database_clusters.py b/troveclient/osc/v1/database_clusters.py index eaf36ff..9955d4f 100644 --- a/troveclient/osc/v1/database_clusters.py +++ b/troveclient/osc/v1/database_clusters.py @@ -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 diff --git a/troveclient/osc/v1/database_instances.py b/troveclient/osc/v1/database_instances.py index b33f2c0..54140f8 100644 --- a/troveclient/osc/v1/database_instances.py +++ b/troveclient/osc/v1/database_instances.py @@ -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( |