Skip to content

Commit 107c6b1

Browse files
committed
Fix neutron typos and formatting
Just trying to make things consistent in the neutron files. TrivialFix Change-Id: I9c0ac838f5a956f55161e1636472cca761b14781
1 parent 8660092 commit 107c6b1

18 files changed

Lines changed: 126 additions & 124 deletions

openstackclient/network/v2/floating_ip_port_forwarding.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ def get_parser(self, prog_name):
149149
'--description',
150150
metavar='<description>',
151151
help=_(
152-
"A text to describe/contextualize the use of the "
152+
"Text to describe/contextualize the use of the "
153153
"port forwarding configuration"
154154
),
155155
)
@@ -280,7 +280,7 @@ def get_parser(self, prog_name):
280280
)
281281
parser.add_argument(
282282
'--protocol',
283-
metavar='protocol',
283+
metavar='<protocol>',
284284
help=_("Filter the list result by the port protocol"),
285285
)
286286

@@ -409,7 +409,7 @@ def get_parser(self, prog_name):
409409
'--description',
410410
metavar='<description>',
411411
help=_(
412-
"A text to describe/contextualize the use of "
412+
"Text to describe/contextualize the use of "
413413
"the port forwarding configuration"
414414
),
415415
)

openstackclient/network/v2/l3_conntrack_helper.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ def get_parser(self, prog_name):
9999
parser.add_argument(
100100
'router',
101101
metavar='<router>',
102-
help=_('Router that the conntrack helper belong to'),
102+
help=_('Router that the conntrack helper belongs to'),
103103
)
104104
parser.add_argument(
105105
'conntrack_helper_id',
@@ -147,7 +147,7 @@ def get_parser(self, prog_name):
147147
parser.add_argument(
148148
'router',
149149
metavar='<router>',
150-
help=_('Router that the conntrack helper belong to'),
150+
help=_('Router that the conntrack helper belongs to'),
151151
)
152152
parser.add_argument(
153153
'--helper',
@@ -210,7 +210,7 @@ def get_parser(self, prog_name):
210210
parser.add_argument(
211211
'router',
212212
metavar='<router>',
213-
help=_('Router that the conntrack helper belong to'),
213+
help=_('Router that the conntrack helper belongs to'),
214214
)
215215
parser.add_argument(
216216
'conntrack_helper_id',
@@ -257,7 +257,7 @@ def get_parser(self, prog_name):
257257
parser.add_argument(
258258
'router',
259259
metavar='<router>',
260-
help=_('Router that the conntrack helper belong to'),
260+
help=_('Router that the conntrack helper belongs to'),
261261
)
262262
parser.add_argument(
263263
'conntrack_helper_id',

openstackclient/network/v2/local_ip.py

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -74,30 +74,32 @@ class CreateLocalIP(command.ShowOne):
7474
def get_parser(self, prog_name):
7575
parser = super().get_parser(prog_name)
7676
parser.add_argument(
77-
'--name', metavar="<name>", help=_("New local IP name")
77+
'--name', metavar="<name>", help=_("New Local IP name")
7878
)
7979
parser.add_argument(
8080
'--description',
8181
metavar="<description>",
82-
help=_("New local IP description"),
82+
help=_("Description for Local IP"),
8383
)
8484
parser.add_argument(
8585
'--network',
8686
metavar='<network>',
87-
help=_("Network to allocate Local IP (name or ID)"),
87+
help=_("Network to allocate Local IP from (name or ID)"),
8888
)
8989
parser.add_argument(
9090
'--local-port',
9191
metavar='<local-port>',
92-
help=_("Port to allocate Local IP (name or ID)"),
92+
help=_("Port to allocate Local IP from (name or ID)"),
9393
)
9494
parser.add_argument(
9595
"--local-ip-address",
9696
metavar="<local-ip-address>",
97-
help=_("IP address or CIDR "),
97+
help=_("IP address or CIDR for Local IP"),
9898
)
9999
parser.add_argument(
100-
'--ip-mode', metavar='<ip-mode>', help=_("local IP ip mode")
100+
'--ip-mode',
101+
metavar='<ip-mode>',
102+
help=_("IP mode to use for Local IP"),
101103
)
102104

103105
identity_common.add_project_domain_option_to_parser(parser)
@@ -116,7 +118,7 @@ def take_action(self, parsed_args):
116118

117119

118120
class DeleteLocalIP(command.Command):
119-
_description = _("Delete local IP(s)")
121+
_description = _("Delete Local IP(s)")
120122

121123
def get_parser(self, prog_name):
122124
parser = super().get_parser(prog_name)
@@ -156,7 +158,7 @@ def take_action(self, parsed_args):
156158

157159

158160
class SetLocalIP(command.Command):
159-
_description = _("Set local ip properties")
161+
_description = _("Set Local IP properties")
160162

161163
def get_parser(self, prog_name):
162164
parser = super().get_parser(prog_name)
@@ -171,7 +173,7 @@ def get_parser(self, prog_name):
171173
parser.add_argument(
172174
'--description',
173175
metavar="<description>",
174-
help=_('Set local IP description'),
176+
help=_('Set Local IP description'),
175177
)
176178
return parser
177179

@@ -188,15 +190,15 @@ def take_action(self, parsed_args):
188190

189191

190192
class ListLocalIP(command.Lister):
191-
_description = _("List local IPs")
193+
_description = _("List Local IPs")
192194

193195
def get_parser(self, prog_name):
194196
parser = super().get_parser(prog_name)
195197

196198
parser.add_argument(
197199
'--name',
198200
metavar='<name>',
199-
help=_("List only local IPs of given name in output"),
201+
help=_("List only Local IPs of given name in output"),
200202
)
201203
parser.add_argument(
202204
'--project',
@@ -295,7 +297,7 @@ def take_action(self, parsed_args):
295297

296298

297299
class ShowLocalIP(command.ShowOne):
298-
_description = _("Display local IP details")
300+
_description = _("Display Local IP details")
299301

300302
def get_parser(self, prog_name):
301303
parser = super().get_parser(prog_name)

openstackclient/network/v2/ndp_proxy.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ def get_parser(self, prog_name):
6969
'--description',
7070
metavar='<description>',
7171
help=_(
72-
"A text to describe/contextualize the use of the "
72+
"Text to describe/contextualize the use of the "
7373
"NDP proxy configuration"
7474
),
7575
)
@@ -156,18 +156,18 @@ def get_parser(self, prog_name):
156156
)
157157
parser.add_argument(
158158
'--ip-address',
159-
metavar='ip-address',
160-
help=_("List only NDP proxies according to their IPv6 address"),
159+
metavar='<ip-address>',
160+
help=_("List only NDP proxies associated to this IPv6 address"),
161161
)
162162
parser.add_argument(
163163
'--project',
164164
metavar='<project>',
165-
help=_("List NDP proxies according to their project (name or ID)"),
165+
help=_("List only NDP proxies of given project (name or ID)"),
166166
)
167167
parser.add_argument(
168168
'--name',
169169
metavar='<name>',
170-
help=_("List NDP proxies according to their name"),
170+
help=_("List only NDP proxies of given name"),
171171
)
172172

173173
identity_common.add_project_domain_option_to_parser(parser)
@@ -247,7 +247,7 @@ def get_parser(self, prog_name):
247247
'--description',
248248
metavar='<description>',
249249
help=_(
250-
"A text to describe/contextualize the use of "
250+
"Text to describe/contextualize the use of "
251251
"the NDP proxy configuration"
252252
),
253253
)

openstackclient/network/v2/network.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ def _add_additional_network_options(parser):
166166
help=_(
167167
"The physical mechanism by which the virtual network "
168168
"is implemented. For example: "
169-
"flat, geneve, gre, local, vlan, vxlan."
169+
"flat, geneve, gre, local, vlan or vxlan."
170170
),
171171
)
172172
parser.add_argument(
@@ -292,8 +292,8 @@ def update_parser_network(self, parser):
292292
action='store_true',
293293
help=self.enhance_help_neutron(
294294
_(
295-
"The network has an external routing facility that's not "
296-
"managed by Neutron and can be used as in: "
295+
"The network has an external routing facility that is not "
296+
"managed by Neutron and can be used. For example: "
297297
"openstack router set --external-gateway NETWORK "
298298
"(external-net extension required)"
299299
)
@@ -537,7 +537,7 @@ def update_parser_network(self, parser):
537537
_(
538538
"List networks according to their physical mechanisms. "
539539
"The supported options are: flat, geneve, gre, local, "
540-
"vlan, vxlan."
540+
"vlan and vxlan."
541541
)
542542
),
543543
)
@@ -789,10 +789,10 @@ def get_parser(self, prog_name):
789789
'--external',
790790
action='store_true',
791791
help=_(
792-
"The network has an external routing facility that's not "
793-
"managed by Neutron and can be used as in: "
792+
"The network has an external routing facility that is not "
793+
"managed by Neutron and can be used. For example: "
794794
"openstack router set --external-gateway NETWORK "
795-
"(external-net extension required)"
795+
"(external-net extension required)."
796796
),
797797
)
798798
external_router_grp.add_argument(

openstackclient/network/v2/network_auto_allocated_topology.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ def get_parser(self, prog_name):
7171
metavar='<project>',
7272
help=_(
7373
"Return the auto allocated topology for a given project. "
74-
"Default is current project"
74+
"Default is current project."
7575
),
7676
)
7777
identity_common.add_project_domain_option_to_parser(parser)
@@ -89,7 +89,7 @@ def get_parser(self, prog_name):
8989
default=True,
9090
help=_(
9191
"If topology exists returns the topology's "
92-
"information (Default)"
92+
"information (default)"
9393
),
9494
)
9595

@@ -132,7 +132,7 @@ def get_parser(self, prog_name):
132132
metavar='<project>',
133133
help=_(
134134
'Delete auto allocated topology for a given project. '
135-
'Default is the current project'
135+
'Default is the current project.'
136136
),
137137
)
138138
identity_common.add_project_domain_option_to_parser(parser)

openstackclient/network/v2/network_flavor.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ def get_parser(self, prog_name):
102102
metavar="<service-type>",
103103
required=True,
104104
help=_(
105-
'Service type to which the flavor applies to: e.g. VPN '
105+
'Service type to which the flavor applies. For example: VPN '
106106
'(See openstack network service provider list for loaded '
107107
'examples.)'
108108
),

openstackclient/network/v2/network_flavor_profile.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,14 +79,14 @@ def get_parser(self, prog_name):
7979
'--driver',
8080
help=_(
8181
"Python module path to driver. This becomes "
82-
"required if --metainfo is missing and vice versa"
82+
"required if --metainfo is missing and vice-versa."
8383
),
8484
)
8585
parser.add_argument(
8686
'--metainfo',
8787
help=_(
8888
"Metainfo for the flavor profile. This becomes "
89-
"required if --driver is missing and vice versa"
89+
"required if --driver is missing and vice-versa."
9090
),
9191
)
9292

@@ -217,14 +217,14 @@ def get_parser(self, prog_name):
217217
'--driver',
218218
help=_(
219219
"Python module path to driver. This becomes "
220-
"required if --metainfo is missing and vice versa"
220+
"required if --metainfo is missing and vice-versa."
221221
),
222222
)
223223
parser.add_argument(
224224
'--metainfo',
225225
help=_(
226226
"Metainfo for the flavor profile. This becomes "
227-
"required if --driver is missing and vice versa"
227+
"required if --driver is missing and vice-versa."
228228
),
229229
)
230230

openstackclient/network/v2/network_meter.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ def get_parser(self, prog_name):
7070
parser.add_argument(
7171
'--description',
7272
metavar='<description>',
73-
help=_("Create description for meter"),
73+
help=_("Description for meter"),
7474
)
7575
parser.add_argument(
7676
'--project',

openstackclient/network/v2/network_qos_policy.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -190,20 +190,20 @@ def get_parser(self, prog_name):
190190
'--project',
191191
metavar='<project>',
192192
help=_(
193-
"List qos policies according to their project (name or ID)"
193+
"List QoS policies according to their project (name or ID)"
194194
),
195195
)
196196
identity_common.add_project_domain_option_to_parser(parser)
197197
shared_group = parser.add_mutually_exclusive_group()
198198
shared_group.add_argument(
199199
'--share',
200200
action='store_true',
201-
help=_("List qos policies shared between projects"),
201+
help=_("List QoS policies shared between projects"),
202202
)
203203
shared_group.add_argument(
204204
'--no-share',
205205
action='store_true',
206-
help=_("List qos policies not shared between projects"),
206+
help=_("List QoS policies not shared between projects"),
207207
)
208208
return parser
209209

0 commit comments

Comments
 (0)