diff options
| author | Dean Troyer <dtroyer@gmail.com> | 2017-04-03 16:15:14 -0500 |
|---|---|---|
| committer | Steve Martinelli <s.martinelli@gmail.com> | 2017-04-04 03:56:19 +0000 |
| commit | 1686dc54f09b6e77b1de3abc708c297710987a04 (patch) | |
| tree | 6c02758c2006da60f634940324c607e6785b433f /openstackclient/network | |
| parent | b2ceb58fc377cd9030becaa934fc4e5d13cb55b4 (diff) | |
| download | python-openstackclient-1686dc54f09b6e77b1de3abc708c297710987a04.tar.gz | |
Help/docs cleanups: marker, limit, ip-address metavars
Cleanup help strings and docs for clarity and to keep things consistent:
* --limit metavar should be <num-resource> to indicate what is being counted
* --marker metavar should be <resource> or <resource-id> to indicate the
type of value being specified
* <*-ip-address> metavars should be just <ip-address> 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
Diffstat (limited to 'openstackclient/network')
| -rw-r--r-- | openstackclient/network/v2/floating_ip.py | 6 | ||||
| -rw-r--r-- | openstackclient/network/v2/port.py | 14 | ||||
| -rw-r--r-- | openstackclient/network/v2/subnet.py | 4 | ||||
| -rw-r--r-- | openstackclient/network/v2/subnet_pool.py | 2 |
4 files changed, 13 insertions, 13 deletions
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='<floating-ip-address>', + metavar='<ip-address>', dest='floating_ip_address', help=_("Floating IP address") ) parser.add_argument( '--fixed-ip-address', - metavar='<fixed-ip-address>', + metavar='<ip-address>', 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='<fixed-ip-address>', + metavar='<ip-address>', 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=<subnet>,ip-address=<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=<subnet>,ip-address=<ip-address> " "(repeat option to set multiple fixed IP addresses)") ) @@ -496,9 +496,9 @@ class ListPort(command.Lister): metavar='subnet=<subnet>,ip-address=<ip-address>', action=parseractions.MultiKeyValueAction, optional_keys=['subnet', 'ip-address'], - help=_("Desired IP and/or subnet (name or ID) for filtering " - "ports: subnet=<subnet>,ip-address=<ip-address> " - "(repeat option to set multiple fixed IP addresses)") + help=_("Desired IP and/or subnet for filtering ports " + "(name or ID): subnet=<subnet>,ip-address=<ip-address> " + "(repeat option to set multiple fixed IP addresses)"), ) return parser @@ -593,7 +593,7 @@ class SetPort(command.Command): metavar='subnet=<subnet>,ip-address=<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=<subnet>,ip-address=<ip-address> " "(repeat option to set multiple fixed IP addresses)") ) @@ -757,8 +757,8 @@ class UnsetPort(command.Command): metavar='subnet=<subnet>,ip-address=<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=<subnet>," + help=_("Desired IP and/or subnet which should be " + "removed from this port (name or ID): subnet=<subnet>," "ip-address=<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='<project>', 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='<network>', 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='<address-scope>', help=_("List only subnet pools of given address scope " - "(name or ID) in output") + "in output (name or ID)") ) return parser |
