From 72b4441fe1413396db2e0e11113033d9e562e934 Mon Sep 17 00:00:00 2001 From: Takashi NATSUME Date: Wed, 12 Sep 2018 00:25:31 +0900 Subject: [PATCH] Improve the description of optional arguments 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 --- doc/source/cli/nova.rst | 10 +++++----- novaclient/v2/shell.py | 8 ++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/source/cli/nova.rst b/doc/source/cli/nova.rst index af9660aab..35799551d 100644 --- a/doc/source/cli/nova.rst +++ b/doc/source/cli/nova.rst @@ -1943,13 +1943,13 @@ List actions on a server. ``--limit `` 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 - 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') ``--changes-since `` List only instance actions changed after a certain point of 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: @@ -2464,14 +2464,14 @@ Print a list of migrations. ``--limit `` 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 - between what is requested here and what is configured in the server. + max limit on the server, and the limit that is used will be the minimum of + what is requested here and what is configured in the server. (Supported by API versions '2.59' - '2.latest') ``--changes-since `` List only migrations changed after a certain point of 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: diff --git a/novaclient/v2/shell.py b/novaclient/v2/shell.py index e6a09a61f..0bf6da8ee 100644 --- a/novaclient/v2/shell.py +++ b/novaclient/v2/shell.py @@ -5044,7 +5044,7 @@ def do_instance_action_list(cs, args): default=None, help=_('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 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.')) @utils.arg( '--changes-since', @@ -5053,7 +5053,7 @@ def do_instance_action_list(cs, args): default=None, help=_('List only instance actions changed after a certain point of ' '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): """List actions on a server.""" server = _find_server(cs, args.server, raise_if_notfound=False) @@ -5197,7 +5197,7 @@ def do_migration_list(cs, args): default=None, help=_('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 between what is requested here and what ' + 'will be the minimum of what is requested here and what ' 'is configured in the server.')) @utils.arg( '--changes-since', @@ -5206,7 +5206,7 @@ def do_migration_list(cs, args): default=None, help=_('List only migrations changed after a certain point of 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): """Print a list of migrations.""" if args.changes_since: