openstack/python-novaclient
Code Issues Proposed changes

Improve the description of optional arguments

Browse Source 
This patch is a follow-up patch for
Ib4ce831a5031459d350fa73601e878e7b319640f.

Improve the description of optional arguments
in the CLI reference and help text.

Change-Id: I6313b8a584385daa7e9fbd558d431faa43015449
This commit is contained in:
Takashi NATSUME 2018-09-12 00:25:31 +09:00
parent b5a4a47977
commit 72b4441fe1
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/cli/nova.rst
View File

@ -1943,13 +1943,13 @@ List actions on a server.
``--limit <limit>`` ``--limit <limit>``
Maximum number of instance actions to display. Note that there is Maximum number of instance actions to display. Note that there is
a configurable max limit on the server, and the limit that is used will be a configurable max limit on the server, and the limit that is used will be
the minimum between what is requested here and what is configured the minimum of what is requested here and what is configured
in the server. (Supported by API versions '2.58' - '2.latest') in the server. (Supported by API versions '2.58' - '2.latest')
``--changes-since <changes_since>`` ``--changes-since <changes_since>``
List only instance actions changed after a certain point of time. List only instance actions changed after a certain point of time.
The provided time should be an ISO 8061 formatted time. The provided time should be an ISO 8061 formatted time.
ex 2016-03-04T06:27:59Z. (Supported by API versions '2.58' - '2.latest') e.g. 2016-03-04T06:27:59Z. (Supported by API versions '2.58' - '2.latest')
.. _nova_interface-attach: .. _nova_interface-attach:
@ -2464,14 +2464,14 @@ Print a list of migrations.
``--limit <limit>`` ``--limit <limit>``
Maximum number of migrations to display. Note that there is a configurable Maximum number of migrations to display. Note that there is a configurable
max limit on the server, and the limit that is used will be the minimum max limit on the server, and the limit that is used will be the minimum of
between what is requested here and what is configured in the server. what is requested here and what is configured in the server.
(Supported by API versions '2.59' - '2.latest') (Supported by API versions '2.59' - '2.latest')
``--changes-since <changes_since>`` ``--changes-since <changes_since>``
List only migrations changed after a certain point of time. List only migrations changed after a certain point of time.
The provided time should be an ISO 8061 formatted time. The provided time should be an ISO 8061 formatted time.
ex 2016-03-04T06:27:59Z . (Supported by API versions '2.59' - '2.latest') e.g. 2016-03-04T06:27:59Z . (Supported by API versions '2.59' - '2.latest')
.. _nova_pause: .. _nova_pause:

8
novaclient/v2/shell.py
View File

@ -5044,7 +5044,7 @@ def do_instance_action_list(cs, args):
default=None, default=None,
help=_('Maximum number of instance actions to display. Note that there ' help=_('Maximum number of instance actions to display. Note that there '
'is a configurable max limit on the server, and the limit that is ' 'is a configurable max limit on the server, and the limit that is '
'used will be the minimum between what is requested here and what ' 'used will be the minimum of what is requested here and what '
'is configured in the server.')) 'is configured in the server.'))
@utils.arg( @utils.arg(
'--changes-since', '--changes-since',
@ -5053,7 +5053,7 @@ def do_instance_action_list(cs, args):
default=None, default=None,
help=_('List only instance actions changed after a certain point of ' help=_('List only instance actions changed after a certain point of '
'time. The provided time should be an ISO 8061 formatted time. ' 'time. The provided time should be an ISO 8061 formatted time. '
'ex 2016-03-04T06:27:59Z.')) 'e.g. 2016-03-04T06:27:59Z.'))
def do_instance_action_list(cs, args): def do_instance_action_list(cs, args):
"""List actions on a server.""" """List actions on a server."""
server = _find_server(cs, args.server, raise_if_notfound=False) server = _find_server(cs, args.server, raise_if_notfound=False)
@ -5197,7 +5197,7 @@ def do_migration_list(cs, args):
default=None, default=None,
help=_('Maximum number of migrations to display. Note that there is a ' help=_('Maximum number of migrations to display. Note that there is a '
'configurable max limit on the server, and the limit that is used ' 'configurable max limit on the server, and the limit that is used '
'will be the minimum between what is requested here and what ' 'will be the minimum of what is requested here and what '
'is configured in the server.')) 'is configured in the server.'))
@utils.arg( @utils.arg(
'--changes-since', '--changes-since',
@ -5206,7 +5206,7 @@ def do_migration_list(cs, args):
default=None, default=None,
help=_('List only migrations changed after a certain point of time. ' help=_('List only migrations changed after a certain point of time. '
'The provided time should be an ISO 8061 formatted time. ' 'The provided time should be an ISO 8061 formatted time. '
'ex 2016-03-04T06:27:59Z .')) 'e.g. 2016-03-04T06:27:59Z .'))
def do_migration_list(cs, args): def do_migration_list(cs, args):
"""Print a list of migrations.""" """Print a list of migrations."""
if args.changes_since: if args.changes_since: