Skip to content

Commit e0cf68f

Browse files
Jenkinsopenstack-gerrit
Jenkins
authored and
openstack-gerrit
committed
Merge "Normalize more help strings"
2 parents 8c556e6 + 5bb6c72 commit e0cf68f

9 files changed

Lines changed: 58 additions & 53 deletions

File tree

‎openstackclient/compute/v2/console.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727

2828
class ShowConsoleLog(command.Command):
29-
"""Show console-log command"""
29+
"""Show server's console output"""
3030

3131
log = logging.getLogger(__name__ + '.ShowConsoleLog')
3232

@@ -35,7 +35,7 @@ def get_parser(self, prog_name):
3535
parser.add_argument(
3636
'server',
3737
metavar='<server>',
38-
help='Name or ID of server to display console log',
38+
help='Server (name or ID)',
3939
)
4040
parser.add_argument(
4141
'--lines',
@@ -67,7 +67,7 @@ def take_action(self, parsed_args):
6767

6868

6969
class ShowConsoleURL(show.ShowOne):
70-
"""Show console-url command"""
70+
"""Show server's remote console URL"""
7171

7272
log = logging.getLogger(__name__ + '.ShowConsoleURL')
7373

@@ -76,7 +76,7 @@ def get_parser(self, prog_name):
7676
parser.add_argument(
7777
'server',
7878
metavar='<server>',
79-
help='Name or ID of server to display console log',
79+
help='Server (name or ID)',
8080
)
8181
type_group = parser.add_mutually_exclusive_group()
8282
type_group.add_argument(

‎openstackclient/compute/v2/flavor.py‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727

2828
class CreateFlavor(show.ShowOne):
29-
"""Create flavor command"""
29+
"""Create new flavor"""
3030

3131
log = logging.getLogger(__name__ + ".CreateFlavor")
3232

@@ -35,7 +35,8 @@ def get_parser(self, prog_name):
3535
parser.add_argument(
3636
"name",
3737
metavar="<name>",
38-
help="Name of the new flavor")
38+
help="New flavor name",
39+
)
3940
parser.add_argument(
4041
"--id",
4142
metavar="<id>",
@@ -84,12 +85,14 @@ def get_parser(self, prog_name):
8485
dest="public",
8586
action="store_true",
8687
default=True,
87-
help="Flavor is accessible to the public (default)")
88+
help="Flavor is accessible to other projects (default)",
89+
)
8890
public_group.add_argument(
8991
"--private",
9092
dest="public",
9193
action="store_false",
92-
help="Flavor is inaccessible to the public")
94+
help="Flavor is inaccessible to other projects",
95+
)
9396
return parser
9497

9598
def take_action(self, parsed_args):
@@ -115,7 +118,7 @@ def take_action(self, parsed_args):
115118

116119

117120
class DeleteFlavor(command.Command):
118-
"""Delete flavor command"""
121+
"""Delete a flavor"""
119122

120123
log = logging.getLogger(__name__ + ".DeleteFlavor")
121124

@@ -124,7 +127,8 @@ def get_parser(self, prog_name):
124127
parser.add_argument(
125128
"flavor",
126129
metavar="<flavor>",
127-
help="Name or ID of flavor to delete")
130+
help="Flavor to delete (name or ID)",
131+
)
128132
return parser
129133

130134
def take_action(self, parsed_args):
@@ -137,7 +141,7 @@ def take_action(self, parsed_args):
137141

138142

139143
class ListFlavor(lister.Lister):
140-
"""List flavor command"""
144+
"""List flavors"""
141145

142146
log = logging.getLogger(__name__ + ".ListFlavor")
143147

@@ -164,7 +168,7 @@ def take_action(self, parsed_args):
164168

165169

166170
class ShowFlavor(show.ShowOne):
167-
"""Show flavor command"""
171+
"""Show flavor details"""
168172

169173
log = logging.getLogger(__name__ + ".ShowFlavor")
170174

@@ -173,7 +177,8 @@ def get_parser(self, prog_name):
173177
parser.add_argument(
174178
"flavor",
175179
metavar="<flavor>",
176-
help="Name or ID of flavor to display")
180+
help="Flavor to display (name or ID)",
181+
)
177182
return parser
178183

179184
def take_action(self, parsed_args):

‎openstackclient/compute/v2/floatingip.py‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727

2828
class AddFloatingIP(command.Command):
29-
"""Add floating-ip command"""
29+
"""Add floating-ip to server"""
3030

3131
log = logging.getLogger(__name__ + ".AddFloatingIP")
3232

@@ -40,7 +40,7 @@ def get_parser(self, prog_name):
4040
parser.add_argument(
4141
"server",
4242
metavar="<server>",
43-
help="Name of the server to receive the IP address",
43+
help="Server to receive the IP address (name or ID)",
4444
)
4545
return parser
4646

@@ -56,7 +56,7 @@ def take_action(self, parsed_args):
5656

5757

5858
class CreateFloatingIP(show.ShowOne):
59-
"""Create floating-ip command"""
59+
"""Create new floating-ip"""
6060

6161
log = logging.getLogger(__name__ + '.CreateFloatingIP')
6262

@@ -80,7 +80,7 @@ def take_action(self, parsed_args):
8080

8181

8282
class DeleteFloatingIP(command.Command):
83-
"""Delete floating-ip command"""
83+
"""Delete a floating-ip"""
8484

8585
log = logging.getLogger(__name__ + '.DeleteFloatingIP')
8686

@@ -107,7 +107,7 @@ def take_action(self, parsed_args):
107107

108108

109109
class ListFloatingIP(lister.Lister):
110-
"""List floating-ip command"""
110+
"""List floating-ips"""
111111

112112
log = logging.getLogger(__name__ + '.ListFloatingIP')
113113

@@ -127,7 +127,7 @@ def take_action(self, parsed_args):
127127

128128

129129
class RemoveFloatingIP(command.Command):
130-
"""Remove floating-ip command"""
130+
"""Remove floating-ip from server"""
131131

132132
log = logging.getLogger(__name__ + ".RemoveFloatingIP")
133133

@@ -141,7 +141,7 @@ def get_parser(self, prog_name):
141141
parser.add_argument(
142142
"server",
143143
metavar="<server>",
144-
help="Name of the server to remove the IP address from",
144+
help="Server to remove the IP address from (name or ID)",
145145
)
146146
return parser
147147

‎openstackclient/compute/v2/floatingippool.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424

2525
class ListFloatingIPPool(lister.Lister):
26-
"""List floating-ip-pool command"""
26+
"""List floating-ip-pools"""
2727

2828
log = logging.getLogger(__name__ + '.ListFloatingIPPool')
2929

‎openstackclient/compute/v2/hypervisor.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,17 @@
2525

2626

2727
class ListHypervisor(lister.Lister):
28-
"""List hypervisor command"""
28+
"""List hypervisors"""
2929

3030
log = logging.getLogger(__name__ + ".ListHypervisor")
3131

3232
def get_parser(self, prog_name):
3333
parser = super(ListHypervisor, self).get_parser(prog_name)
3434
parser.add_argument(
3535
"--matching",
36-
metavar="<hostname>",
37-
help="List hypervisors with hostnames matching the given"
38-
" substring")
36+
metavar="<hostname-str>",
37+
help="Filter hypervisors using <hostname-str> substring",
38+
)
3939
return parser
4040

4141
def take_action(self, parsed_args):
@@ -58,7 +58,7 @@ def take_action(self, parsed_args):
5858

5959

6060
class ShowHypervisor(show.ShowOne):
61-
"""Show hypervisor command"""
61+
"""Show hypervisor details"""
6262

6363
log = logging.getLogger(__name__ + ".ShowHypervisor")
6464

‎openstackclient/compute/v2/keypair.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929

3030

3131
class CreateKeypair(show.ShowOne):
32-
"""Create keypair command"""
32+
"""Create new keypair"""
3333

3434
log = logging.getLogger(__name__ + '.CreateKeypair')
3535

@@ -79,7 +79,7 @@ def take_action(self, parsed_args):
7979

8080

8181
class DeleteKeypair(command.Command):
82-
"""Delete keypair command"""
82+
"""Delete a keypair"""
8383

8484
log = logging.getLogger(__name__ + '.DeleteKeypair')
8585

@@ -100,7 +100,7 @@ def take_action(self, parsed_args):
100100

101101

102102
class ListKeypair(lister.Lister):
103-
"""List keypair command"""
103+
"""List keypairs"""
104104

105105
log = logging.getLogger(__name__ + ".ListKeypair")
106106

@@ -120,7 +120,7 @@ def take_action(self, parsed_args):
120120

121121

122122
class ShowKeypair(show.ShowOne):
123-
"""Show keypair command"""
123+
"""Show keypair details"""
124124

125125
log = logging.getLogger(__name__ + '.ShowKeypair')
126126

‎openstackclient/identity/v2_0/token.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def take_action(self, parsed_args):
4141

4242

4343
class RevokeToken(command.Command):
44-
"""Revoke token command"""
44+
"""Revoke existing token"""
4545

4646
log = logging.getLogger(__name__ + '.RevokeToken')
4747

‎openstackclient/identity/v3/identity_provider.py‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@
2525

2626

2727
class CreateIdentityProvider(show.ShowOne):
28-
"""Create identity_provider command"""
28+
"""Create new identity provider"""
2929

3030
log = logging.getLogger(__name__ + '.CreateIdentityProvider')
3131

3232
def get_parser(self, prog_name):
3333
parser = super(CreateIdentityProvider, self).get_parser(prog_name)
3434
parser.add_argument(
3535
'identity_provider_id',
36-
metavar='<identity_provider_id>',
36+
metavar='<identity-provider-id>',
3737
help='New identity provider ID (must be unique)'
3838
)
3939
parser.add_argument(
@@ -71,16 +71,16 @@ def take_action(self, parsed_args):
7171

7272

7373
class DeleteIdentityProvider(command.Command):
74-
"""Delete identity provider"""
74+
"""Delete an identity provider"""
7575

7676
log = logging.getLogger(__name__ + '.DeleteIdentityProvider')
7777

7878
def get_parser(self, prog_name):
7979
parser = super(DeleteIdentityProvider, self).get_parser(prog_name)
8080
parser.add_argument(
8181
'identity_provider',
82-
metavar='<identity_provider>',
83-
help='ID of the identity provider to be deleted',
82+
metavar='<identity-provider-id>',
83+
help='Identity provider ID to delete',
8484
)
8585
return parser
8686

@@ -110,16 +110,16 @@ def take_action(self, parsed_args):
110110

111111

112112
class SetIdentityProvider(command.Command):
113-
"""Set identity provider"""
113+
"""Set identity provider properties"""
114114

115115
log = logging.getLogger(__name__ + '.SetIdentityProvider')
116116

117117
def get_parser(self, prog_name):
118118
parser = super(SetIdentityProvider, self).get_parser(prog_name)
119119
parser.add_argument(
120120
'identity_provider',
121-
metavar='<identity_provider>',
122-
help='ID of the identity provider to be changed',
121+
metavar='<identity-provider-id>',
122+
help='Identity provider ID to change',
123123
)
124124

125125
enable_identity_provider = parser.add_mutually_exclusive_group()
@@ -156,16 +156,16 @@ def take_action(self, parsed_args):
156156

157157

158158
class ShowIdentityProvider(show.ShowOne):
159-
"""Show identity provider"""
159+
"""Show identity provider details"""
160160

161161
log = logging.getLogger(__name__ + '.ShowIdentityProvider')
162162

163163
def get_parser(self, prog_name):
164164
parser = super(ShowIdentityProvider, self).get_parser(prog_name)
165165
parser.add_argument(
166166
'identity_provider',
167-
metavar='<identity_provider>',
168-
help='ID of the identity provider to be displayed',
167+
metavar='<identity-provider-id>',
168+
help='Identity provider ID to show',
169169
)
170170
return parser
171171

0 commit comments

Comments
 (0)