From 32c627eaf0481eb593388d2d76abffcf2b721136 Mon Sep 17 00:00:00 2001 From: Tang Chen Date: Tue, 12 Apr 2016 15:57:17 +0800 Subject: Doc: Unify repeatable option comments There are lots of "this option can be repeated" comments in the doc, which are not consistent to other similar docs. This patch changes them to the following format: "repeat option to do something" Change-Id: I54e01053091c428bf87bb36bb95f73a0b80ab6e7 --- openstackclient/network/v2/network.py | 2 +- openstackclient/network/v2/port.py | 8 ++++---- openstackclient/network/v2/router.py | 10 +++++----- openstackclient/network/v2/subnet.py | 8 ++++---- openstackclient/network/v2/subnet_pool.py | 4 ++-- 5 files changed, 16 insertions(+), 16 deletions(-) (limited to 'openstackclient/network') diff --git a/openstackclient/network/v2/network.py b/openstackclient/network/v2/network.py index ebd5cb63..20d943ed 100644 --- a/openstackclient/network/v2/network.py +++ b/openstackclient/network/v2/network.py @@ -142,7 +142,7 @@ class CreateNetwork(common.NetworkAndComputeShowOne): metavar='', help='Availability Zone in which to create this network ' '(requires the Network Availability Zone extension, ' - 'this option can be repeated).', + 'repeat option to set multiple availability zones)', ) external_router_grp = parser.add_mutually_exclusive_group() external_router_grp.add_argument( diff --git a/openstackclient/network/v2/port.py b/openstackclient/network/v2/port.py index a9e80428..820f2ac2 100644 --- a/openstackclient/network/v2/port.py +++ b/openstackclient/network/v2/port.py @@ -210,13 +210,13 @@ class CreatePort(command.ShowOne): optional_keys=['subnet', 'ip-address'], help='Desired IP and/or subnet (name or ID) for this port: ' 'subnet=,ip-address= ' - '(this option can be repeated)') + '(repeat option to set multiple fixed IP addresses)') parser.add_argument( '--binding-profile', metavar='', action=parseractions.KeyValueAction, help='Custom data to be passed as binding:profile: = ' - '(this option can be repeated)') + '(repeat option to set multiple binding:profile data)') admin_group = parser.add_mutually_exclusive_group() admin_group.add_argument( '--enable', @@ -360,7 +360,7 @@ class SetPort(command.Command): optional_keys=['subnet', 'ip-address'], help='Desired IP and/or subnet (name or ID) for this port: ' 'subnet=,ip-address= ' - '(this option can be repeated)') + '(repeat option to set multiple fixed IP addresses)') fixed_ip.add_argument( '--no-fixed-ip', action='store_true', @@ -371,7 +371,7 @@ class SetPort(command.Command): metavar='', action=parseractions.KeyValueAction, help='Custom data to be passed as binding:profile: = ' - '(this option can be repeated)') + '(repeat option to set multiple binding:profile data)') binding_profile.add_argument( '--no-binding-profile', action='store_true', diff --git a/openstackclient/network/v2/router.py b/openstackclient/network/v2/router.py index 6a78be6c..2ededae8 100644 --- a/openstackclient/network/v2/router.py +++ b/openstackclient/network/v2/router.py @@ -179,7 +179,7 @@ class CreateRouter(command.ShowOne): dest='availability_zone_hints', help='Availability Zone in which to create this router ' '(requires the Router Availability Zone extension, ' - 'this option can be repeated).', + 'repeat option to set multiple availability zones)', ) identity_common.add_project_domain_option_to_parser(parser) @@ -368,10 +368,10 @@ class SetRouter(command.Command): dest='routes', default=None, required_keys=['destination', 'gateway'], - help="Routes associated with the router. " - "Repeat this option to set multiple routes. " - "destination: destination subnet (in CIDR notation). " - "gateway: nexthop IP address.", + help="Routes associated with the router " + "destination: destination subnet (in CIDR notation) " + "gateway: nexthop IP address " + "(repeat option to set multiple routes)", ) routes_group.add_argument( '--clear-routes', diff --git a/openstackclient/network/v2/subnet.py b/openstackclient/network/v2/subnet.py index eb96bb1f..8fdb4459 100644 --- a/openstackclient/network/v2/subnet.py +++ b/openstackclient/network/v2/subnet.py @@ -52,15 +52,15 @@ def _get_common_parse_arguments(parser): required_keys=['start', 'end'], help='Allocation pool IP addresses for this subnet ' 'e.g.: start=192.168.199.2,end=192.168.199.254 ' - '(This option can be repeated)', + '(repeat option to add multiple IP addresses)', ) parser.add_argument( '--dns-nameserver', metavar='', action='append', dest='dns_nameservers', - help='DNS name server for this subnet ' - '(This option can be repeated)', + help='DNS server for this subnet ' + '(repeat option to set multiple DNS servers)', ) parser.add_argument( '--host-route', @@ -72,7 +72,7 @@ def _get_common_parse_arguments(parser): 'e.g.: destination=10.10.0.0/16,gateway=192.168.71.254 ' 'destination: destination subnet (in CIDR notation) ' 'gateway: nexthop IP address ' - '(This option can be repeated)', + '(repeat option to add multiple routes)', ) diff --git a/openstackclient/network/v2/subnet_pool.py b/openstackclient/network/v2/subnet_pool.py index 6b6fc090..a4f268b2 100644 --- a/openstackclient/network/v2/subnet_pool.py +++ b/openstackclient/network/v2/subnet_pool.py @@ -65,8 +65,8 @@ def _add_prefix_options(parser): metavar='', dest='prefixes', action='append', - help='Set subnet pool prefixes (in CIDR notation). ' - 'Repeat this option to set multiple prefixes.', + help='Set subnet pool prefixes (in CIDR notation) ' + '(repeat option to set multiple prefixes)', ) parser.add_argument( '--default-prefix-length', -- cgit v1.2.1