From 1686dc54f09b6e77b1de3abc708c297710987a04 Mon Sep 17 00:00:00 2001 From: Dean Troyer Date: Mon, 3 Apr 2017 16:15:14 -0500 Subject: Help/docs cleanups: marker, limit, ip-address metavars Cleanup help strings and docs for clarity and to keep things consistent: * --limit metavar should be to indicate what is being counted * --marker metavar should be or to indicate the type of value being specified * <*-ip-address> metavars should be just as there is no difference in format between fixed and floating IPs * Move all occurances of '(name or ID)' to end of help text Change-Id: I2c31746ed6ded3845244e03e57d809f8bc0e6b9d --- openstackclient/compute/v2/flavor.py | 4 +-- openstackclient/compute/v2/server.py | 45 ++++++++++++++-------------- openstackclient/image/v2/image.py | 8 ++--- openstackclient/network/v2/floating_ip.py | 6 ++-- openstackclient/network/v2/port.py | 14 ++++----- openstackclient/network/v2/subnet.py | 4 +-- openstackclient/network/v2/subnet_pool.py | 2 +- openstackclient/object/v1/container.py | 2 +- openstackclient/object/v1/object.py | 2 +- openstackclient/volume/v1/volume.py | 2 +- openstackclient/volume/v2/backup.py | 4 +-- openstackclient/volume/v2/snapshot.py | 4 +-- openstackclient/volume/v2/volume.py | 4 +-- openstackclient/volume/v2/volume_snapshot.py | 4 +-- openstackclient/volume/v2/volume_type.py | 2 +- 15 files changed, 53 insertions(+), 54 deletions(-) (limited to 'openstackclient') diff --git a/openstackclient/compute/v2/flavor.py b/openstackclient/compute/v2/flavor.py index 009c9bd1..bf9921b7 100644 --- a/openstackclient/compute/v2/flavor.py +++ b/openstackclient/compute/v2/flavor.py @@ -251,13 +251,13 @@ class ListFlavor(command.Lister): ) parser.add_argument( '--marker', - metavar="", + metavar="", help=_("The last flavor ID of the previous page") ) parser.add_argument( '--limit', type=int, - metavar="", + metavar="", help=_("Maximum number of flavors to display") ) return parser diff --git a/openstackclient/compute/v2/server.py b/openstackclient/compute/v2/server.py index 1fe5bb0d..aad1ae99 100644 --- a/openstackclient/compute/v2/server.py +++ b/openstackclient/compute/v2/server.py @@ -197,13 +197,14 @@ class AddFixedIP(command.Command): parser.add_argument( "server", metavar="", - help=_("Server (name or ID) to receive the fixed IP address"), + help=_("Server to receive the fixed IP address (name or ID)"), ) parser.add_argument( "network", metavar="", - help=_("Network (name or ID) to allocate " - "the fixed IP address from"), + help=_( + "Network to allocate the fixed IP address from (name or ID)" + ), ) return parser @@ -227,17 +228,16 @@ class AddFloatingIP(command.Command): parser.add_argument( "server", metavar="", - help=_("Server (name or ID) to receive the floating IP address"), + help=_("Server to receive the floating IP address (name or ID)"), ) parser.add_argument( "ip_address", metavar="", - help=_("Floating IP address (IP address only) to assign " - "to server"), + help=_("Floating IP address to assign to server (IP only)"), ) parser.add_argument( "--fixed-ip-address", - metavar="", + metavar="", help=_("Fixed IP address to associate with this floating IP " "address"), ) @@ -820,21 +820,21 @@ class ListServer(command.Lister): ) parser.add_argument( '--marker', - metavar='', + metavar='', default=None, - help=_('The last server (name or ID) of the previous page. Display' - ' list of servers after marker. Display all servers if not' - ' specified.') + help=_('The last server of the previous page. Display ' + 'list of servers after marker. Display all servers if not ' + 'specified. (name or ID)') ) parser.add_argument( '--limit', - metavar='', + metavar='', type=int, default=None, - help=_("Maximum number of servers to display. If limit equals -1," - " all servers will be displayed. If limit is greater than" - " 'osapi_max_limit' option of Nova API," - " 'osapi_max_limit' will be used instead."), + help=_("Maximum number of servers to display. If limit equals -1, " + "all servers will be displayed. If limit is greater than " + "'osapi_max_limit' option of Nova API, " + "'osapi_max_limit' will be used instead."), ) parser.add_argument( '--deleted', @@ -1295,13 +1295,12 @@ class RemoveFixedIP(command.Command): parser.add_argument( "server", metavar="", - help=_("Server (name or ID) to remove the fixed IP address from"), + help=_("Server to remove the fixed IP address from (name or ID)"), ) parser.add_argument( "ip_address", metavar="", - help=_("Fixed IP address (IP address only) to remove from the " - "server"), + help=_("Fixed IP address to remove from the server (IP only)"), ) return parser @@ -1322,14 +1321,14 @@ class RemoveFloatingIP(command.Command): parser.add_argument( "server", metavar="", - help=_("Server (name or ID) to remove the " - "floating IP address from"), + help=_( + "Server to remove the floating IP address from (name or ID)" + ), ) parser.add_argument( "ip_address", metavar="", - help=_("Floating IP address (IP address only) " - "to remove from server"), + help=_("Floating IP address to remove from server (IP only)"), ) return parser diff --git a/openstackclient/image/v2/image.py b/openstackclient/image/v2/image.py index c4be69f0..766de4de 100644 --- a/openstackclient/image/v2/image.py +++ b/openstackclient/image/v2/image.py @@ -463,17 +463,17 @@ class ListImage(command.Lister): ) parser.add_argument( "--limit", - metavar="", + metavar="", type=int, help=_("Maximum number of images to display."), ) parser.add_argument( '--marker', - metavar='', + metavar='', default=None, - help=_("The last image (name or ID) of the previous page. Display " + help=_("The last image of the previous page. Display " "list of images after marker. Display all images if not " - "specified."), + "specified. (name or ID)"), ) return parser diff --git a/openstackclient/network/v2/floating_ip.py b/openstackclient/network/v2/floating_ip.py index 41b208aa..ee39a299 100644 --- a/openstackclient/network/v2/floating_ip.py +++ b/openstackclient/network/v2/floating_ip.py @@ -162,13 +162,13 @@ class CreateFloatingIP(common.NetworkAndComputeShowOne): ) parser.add_argument( '--floating-ip-address', - metavar='', + metavar='', dest='floating_ip_address', help=_("Floating IP address") ) parser.add_argument( '--fixed-ip-address', - metavar='', + metavar='', dest='fixed_ip_address', help=_("Fixed IP address mapped to the floating IP") ) @@ -307,7 +307,7 @@ class ListFloatingIP(common.NetworkAndComputeLister): ) parser.add_argument( '--fixed-ip-address', - metavar='', + metavar='', help=_("List floating IP(s) according to " "given fixed IP address") ) diff --git a/openstackclient/network/v2/port.py b/openstackclient/network/v2/port.py index f77f566d..9d598fab 100644 --- a/openstackclient/network/v2/port.py +++ b/openstackclient/network/v2/port.py @@ -301,7 +301,7 @@ class CreatePort(command.ShowOne): metavar='subnet=,ip-address=', action=parseractions.MultiKeyValueAction, optional_keys=['subnet', 'ip-address'], - help=_("Desired IP and/or subnet (name or ID) for this port: " + help=_("Desired IP and/or subnet for this port (name or ID): " "subnet=,ip-address= " "(repeat option to set multiple fixed IP addresses)") ) @@ -496,9 +496,9 @@ class ListPort(command.Lister): metavar='subnet=,ip-address=', action=parseractions.MultiKeyValueAction, optional_keys=['subnet', 'ip-address'], - help=_("Desired IP and/or subnet (name or ID) for filtering " - "ports: subnet=,ip-address= " - "(repeat option to set multiple fixed IP addresses)") + help=_("Desired IP and/or subnet for filtering ports " + "(name or ID): subnet=,ip-address= " + "(repeat option to set multiple fixed IP addresses)"), ) return parser @@ -593,7 +593,7 @@ class SetPort(command.Command): metavar='subnet=,ip-address=', action=parseractions.MultiKeyValueAction, optional_keys=['subnet', 'ip-address'], - help=_("Desired IP and/or subnet (name or ID) for this port: " + help=_("Desired IP and/or subnet for this port (name or ID): " "subnet=,ip-address= " "(repeat option to set multiple fixed IP addresses)") ) @@ -757,8 +757,8 @@ class UnsetPort(command.Command): metavar='subnet=,ip-address=', action=parseractions.MultiKeyValueAction, optional_keys=['subnet', 'ip-address'], - help=_("Desired IP and/or subnet (name or ID) which should be " - "removed from this port: subnet=," + help=_("Desired IP and/or subnet which should be " + "removed from this port (name or ID): subnet=," "ip-address= (repeat option to unset multiple " "fixed IP addresses)")) diff --git a/openstackclient/network/v2/subnet.py b/openstackclient/network/v2/subnet.py index 403b4cd2..2fdd11f0 100644 --- a/openstackclient/network/v2/subnet.py +++ b/openstackclient/network/v2/subnet.py @@ -428,14 +428,14 @@ class ListSubnet(command.Lister): '--project', metavar='', help=_("List only subnets which belong to a given project " - "(name or ID) in output") + "in output (name or ID)") ) identity_common.add_project_domain_option_to_parser(parser) parser.add_argument( '--network', metavar='', help=_("List only subnets which belong to a given network " - "(name or ID) in output") + "in output (name or ID)") ) parser.add_argument( '--gateway', diff --git a/openstackclient/network/v2/subnet_pool.py b/openstackclient/network/v2/subnet_pool.py index 04731111..82ad9412 100644 --- a/openstackclient/network/v2/subnet_pool.py +++ b/openstackclient/network/v2/subnet_pool.py @@ -282,7 +282,7 @@ class ListSubnetPool(command.Lister): '--address-scope', metavar='', help=_("List only subnet pools of given address scope " - "(name or ID) in output") + "in output (name or ID)") ) return parser diff --git a/openstackclient/object/v1/container.py b/openstackclient/object/v1/container.py index 88fb8602..9f689ab6 100644 --- a/openstackclient/object/v1/container.py +++ b/openstackclient/object/v1/container.py @@ -119,7 +119,7 @@ class ListContainer(command.Lister): ) parser.add_argument( "--limit", - metavar="", + metavar="", type=int, help=_("Limit the number of containers returned"), ) diff --git a/openstackclient/object/v1/object.py b/openstackclient/object/v1/object.py index 71b6f520..e79cea48 100644 --- a/openstackclient/object/v1/object.py +++ b/openstackclient/object/v1/object.py @@ -139,7 +139,7 @@ class ListObject(command.Lister): ) parser.add_argument( "--limit", - metavar="", + metavar="", type=int, help=_("Limit the number of objects returned"), ) diff --git a/openstackclient/volume/v1/volume.py b/openstackclient/volume/v1/volume.py index 8e1097f5..0121e059 100644 --- a/openstackclient/volume/v1/volume.py +++ b/openstackclient/volume/v1/volume.py @@ -291,7 +291,7 @@ class ListVolume(command.Lister): '--limit', type=int, action=parseractions.NonNegativeAction, - metavar='', + metavar='', help=_('Maximum number of volumes to display'), ) return parser diff --git a/openstackclient/volume/v2/backup.py b/openstackclient/volume/v2/backup.py index 00389fcb..60633a70 100644 --- a/openstackclient/volume/v2/backup.py +++ b/openstackclient/volume/v2/backup.py @@ -202,14 +202,14 @@ class ListVolumeBackup(command.Lister): ) parser.add_argument( '--marker', - metavar='', + metavar='', help=_('The last backup of the previous page (name or ID)'), ) parser.add_argument( '--limit', type=int, action=parseractions.NonNegativeAction, - metavar='', + metavar='', help=_('Maximum number of backups to display'), ) parser.add_argument( diff --git a/openstackclient/volume/v2/snapshot.py b/openstackclient/volume/v2/snapshot.py index a18887e3..82b31033 100644 --- a/openstackclient/volume/v2/snapshot.py +++ b/openstackclient/volume/v2/snapshot.py @@ -146,14 +146,14 @@ class ListSnapshot(command.Lister): ) parser.add_argument( '--marker', - metavar='', + metavar='', help=_('The last snapshot ID of the previous page'), ) parser.add_argument( '--limit', type=int, action=parseractions.NonNegativeAction, - metavar='', + metavar='', help=_('Maximum number of snapshots to display'), ) return parser diff --git a/openstackclient/volume/v2/volume.py b/openstackclient/volume/v2/volume.py index c361d700..2b6c966d 100644 --- a/openstackclient/volume/v2/volume.py +++ b/openstackclient/volume/v2/volume.py @@ -341,14 +341,14 @@ class ListVolume(command.Lister): ) parser.add_argument( '--marker', - metavar='', + metavar='', help=_('The last volume ID of the previous page'), ) parser.add_argument( '--limit', type=int, action=parseractions.NonNegativeAction, - metavar='', + metavar='', help=_('Maximum number of volumes to display'), ) return parser diff --git a/openstackclient/volume/v2/volume_snapshot.py b/openstackclient/volume/v2/volume_snapshot.py index f12cfed9..804c8291 100644 --- a/openstackclient/volume/v2/volume_snapshot.py +++ b/openstackclient/volume/v2/volume_snapshot.py @@ -180,14 +180,14 @@ class ListVolumeSnapshot(command.Lister): ) parser.add_argument( '--marker', - metavar='', + metavar='', help=_('The last snapshot ID of the previous page'), ) parser.add_argument( '--limit', type=int, action=parseractions.NonNegativeAction, - metavar='', + metavar='', help=_('Maximum number of snapshots to display'), ) parser.add_argument( diff --git a/openstackclient/volume/v2/volume_type.py b/openstackclient/volume/v2/volume_type.py index 8d2901f2..64c4d652 100644 --- a/openstackclient/volume/v2/volume_type.py +++ b/openstackclient/volume/v2/volume_type.py @@ -544,7 +544,7 @@ class UnsetVolumeType(command.Command): '--project', metavar='', help=_('Removes volume type access to project (name or ID) ' - ' (admin only)'), + '(admin only)'), ) identity_common.add_project_domain_option_to_parser(parser) parser.add_argument( -- cgit v1.2.1