openstack/python-openstackclient
Code Issues Proposed changes

Normalize more help strings

Browse Source 
Change-Id: I2b21bc904e35c1cc50da369d148e607fe3e8cf90
This commit is contained in:
Dean Troyer 2014-06-20 10:06:05 -05:00
parent ea938e8ddf
commit 5bb6c72ef7
9 changed files with 58 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
openstackclient/compute/v2/console.py
View File

@ -26,7 +26,7 @@ from openstackclient.common import utils
class ShowConsoleLog(command.Command):
"""Show console-log command"""
"""Show server's console output"""
log = logging.getLogger(__name__ + '.ShowConsoleLog')
@ -35,7 +35,7 @@ class ShowConsoleLog(command.Command):
parser.add_argument(
'server',
metavar='<server>',
help='Name or ID of server to display console log',
help='Server (name or ID)',
)
parser.add_argument(
'--lines',
@ -67,7 +67,7 @@ class ShowConsoleLog(command.Command):
class ShowConsoleURL(show.ShowOne):
"""Show console-url command"""
"""Show server's remote console URL"""
log = logging.getLogger(__name__ + '.ShowConsoleURL')
@ -76,7 +76,7 @@ class ShowConsoleURL(show.ShowOne):
parser.add_argument(
'server',
metavar='<server>',
help='Name or ID of server to display console log',
help='Server (name or ID)',
)
type_group = parser.add_mutually_exclusive_group()
type_group.add_argument(

23
openstackclient/compute/v2/flavor.py
View File

@ -26,7 +26,7 @@ from openstackclient.common import utils
class CreateFlavor(show.ShowOne):
"""Create flavor command"""
"""Create new flavor"""
log = logging.getLogger(__name__ + ".CreateFlavor")
@ -35,7 +35,8 @@ class CreateFlavor(show.ShowOne):
parser.add_argument(
"name",
metavar="<name>",
help="Name of the new flavor")
help="New flavor name",
)
parser.add_argument(
"--id",
metavar="<id>",
@ -84,12 +85,14 @@ class CreateFlavor(show.ShowOne):
dest="public",
action="store_true",
default=True,
help="Flavor is accessible to the public (default)")
help="Flavor is accessible to other projects (default)",
)
public_group.add_argument(
"--private",
dest="public",
action="store_false",
help="Flavor is inaccessible to the public")
help="Flavor is inaccessible to other projects",
)
return parser
def take_action(self, parsed_args):
@ -115,7 +118,7 @@ class CreateFlavor(show.ShowOne):
class DeleteFlavor(command.Command):
"""Delete flavor command"""
"""Delete a flavor"""
log = logging.getLogger(__name__ + ".DeleteFlavor")
@ -124,7 +127,8 @@ class DeleteFlavor(command.Command):
parser.add_argument(
"flavor",
metavar="<flavor>",
help="Name or ID of flavor to delete")
help="Flavor to delete (name or ID)",
)
return parser
def take_action(self, parsed_args):
@ -137,7 +141,7 @@ class DeleteFlavor(command.Command):
class ListFlavor(lister.Lister):
"""List flavor command"""
"""List flavors"""
log = logging.getLogger(__name__ + ".ListFlavor")
@ -164,7 +168,7 @@ class ListFlavor(lister.Lister):
class ShowFlavor(show.ShowOne):
"""Show flavor command"""
"""Show flavor details"""
log = logging.getLogger(__name__ + ".ShowFlavor")
@ -173,7 +177,8 @@ class ShowFlavor(show.ShowOne):
parser.add_argument(
"flavor",
metavar="<flavor>",
help="Name or ID of flavor to display")
help="Flavor to display (name or ID)",
)
return parser
def take_action(self, parsed_args):

14
openstackclient/compute/v2/floatingip.py
View File

@ -26,7 +26,7 @@ from openstackclient.common import utils
class AddFloatingIP(command.Command):
"""Add floating-ip command"""
"""Add floating-ip to server"""
log = logging.getLogger(__name__ + ".AddFloatingIP")
@ -40,7 +40,7 @@ class AddFloatingIP(command.Command):
parser.add_argument(
"server",
metavar="<server>",
help="Name of the server to receive the IP address",
help="Server to receive the IP address (name or ID)",
)
return parser
@ -56,7 +56,7 @@ class AddFloatingIP(command.Command):
class CreateFloatingIP(show.ShowOne):
"""Create floating-ip command"""
"""Create new floating-ip"""
log = logging.getLogger(__name__ + '.CreateFloatingIP')
@ -80,7 +80,7 @@ class CreateFloatingIP(show.ShowOne):
class DeleteFloatingIP(command.Command):
"""Delete floating-ip command"""
"""Delete a floating-ip"""
log = logging.getLogger(__name__ + '.DeleteFloatingIP')
@ -107,7 +107,7 @@ class DeleteFloatingIP(command.Command):
class ListFloatingIP(lister.Lister):
"""List floating-ip command"""
"""List floating-ips"""
log = logging.getLogger(__name__ + '.ListFloatingIP')
@ -127,7 +127,7 @@ class ListFloatingIP(lister.Lister):
class RemoveFloatingIP(command.Command):
"""Remove floating-ip command"""
"""Remove floating-ip from server"""
log = logging.getLogger(__name__ + ".RemoveFloatingIP")
@ -141,7 +141,7 @@ class RemoveFloatingIP(command.Command):
parser.add_argument(
"server",
metavar="<server>",
help="Name of the server to remove the IP address from",
help="Server to remove the IP address from (name or ID)",
)
return parser

2
openstackclient/compute/v2/floatingippool.py
View File

@ -23,7 +23,7 @@ from openstackclient.common import utils
class ListFloatingIPPool(lister.Lister):
"""List floating-ip-pool command"""
"""List floating-ip-pools"""
log = logging.getLogger(__name__ + '.ListFloatingIPPool')

10
openstackclient/compute/v2/hypervisor.py
View File

@ -25,7 +25,7 @@ from openstackclient.common import utils
class ListHypervisor(lister.Lister):
"""List hypervisor command"""
"""List hypervisors"""
log = logging.getLogger(__name__ + ".ListHypervisor")
@ -33,9 +33,9 @@ class ListHypervisor(lister.Lister):
parser = super(ListHypervisor, self).get_parser(prog_name)
parser.add_argument(
"--matching",
metavar="<hostname>",
help="List hypervisors with hostnames matching the given"
" substring")
metavar="<hostname-str>",
help="Filter hypervisors using <hostname-str> substring",
)
return parser
def take_action(self, parsed_args):
@ -58,7 +58,7 @@ class ListHypervisor(lister.Lister):
class ShowHypervisor(show.ShowOne):
"""Show hypervisor command"""
"""Show hypervisor details"""
log = logging.getLogger(__name__ + ".ShowHypervisor")

8
openstackclient/compute/v2/keypair.py
View File

@ -29,7 +29,7 @@ from openstackclient.common import utils
class CreateKeypair(show.ShowOne):
"""Create keypair command"""
"""Create new keypair"""
log = logging.getLogger(__name__ + '.CreateKeypair')
@ -79,7 +79,7 @@ class CreateKeypair(show.ShowOne):
class DeleteKeypair(command.Command):
"""Delete keypair command"""
"""Delete a keypair"""
log = logging.getLogger(__name__ + '.DeleteKeypair')
@ -100,7 +100,7 @@ class DeleteKeypair(command.Command):
class ListKeypair(lister.Lister):
"""List keypair command"""
"""List keypairs"""
log = logging.getLogger(__name__ + ".ListKeypair")
@ -120,7 +120,7 @@ class ListKeypair(lister.Lister):
class ShowKeypair(show.ShowOne):
"""Show keypair command"""
"""Show keypair details"""
log = logging.getLogger(__name__ + '.ShowKeypair')

2
openstackclient/identity/v2_0/token.py
View File

@ -41,7 +41,7 @@ class IssueToken(show.ShowOne):
class RevokeToken(command.Command):
"""Revoke token command"""
"""Revoke existing token"""
log = logging.getLogger(__name__ + '.RevokeToken')

22
openstackclient/identity/v3/identity_provider.py
View File

@ -25,7 +25,7 @@ from openstackclient.common import utils
class CreateIdentityProvider(show.ShowOne):
"""Create identity_provider command"""
"""Create new identity provider"""
log = logging.getLogger(__name__ + '.CreateIdentityProvider')
@ -33,7 +33,7 @@ class CreateIdentityProvider(show.ShowOne):
parser = super(CreateIdentityProvider, self).get_parser(prog_name)
parser.add_argument(
'identity_provider_id',
metavar='<identity_provider_id>',
metavar='<identity-provider-id>',
help='New identity provider ID (must be unique)'
)
parser.add_argument(
@ -71,7 +71,7 @@ class CreateIdentityProvider(show.ShowOne):
class DeleteIdentityProvider(command.Command):
"""Delete identity provider"""
"""Delete an identity provider"""
log = logging.getLogger(__name__ + '.DeleteIdentityProvider')
@ -79,8 +79,8 @@ class DeleteIdentityProvider(command.Command):
parser = super(DeleteIdentityProvider, self).get_parser(prog_name)
parser.add_argument(
'identity_provider',
metavar='<identity_provider>',
help='ID of the identity provider to be deleted',
metavar='<identity-provider-id>',
help='Identity provider ID to delete',
)
return parser
@ -109,7 +109,7 @@ class ListIdentityProvider(lister.Lister):
class SetIdentityProvider(command.Command):
"""Set identity provider"""
"""Set identity provider properties"""
log = logging.getLogger(__name__ + '.SetIdentityProvider')
@ -117,8 +117,8 @@ class SetIdentityProvider(command.Command):
parser = super(SetIdentityProvider, self).get_parser(prog_name)
parser.add_argument(
'identity_provider',
metavar='<identity_provider>',
help='ID of the identity provider to be changed',
metavar='<identity-provider-id>',
help='Identity provider ID to change',
)
enable_identity_provider = parser.add_mutually_exclusive_group()
@ -155,7 +155,7 @@ class SetIdentityProvider(command.Command):
class ShowIdentityProvider(show.ShowOne):
"""Show identity provider"""
"""Show identity provider details"""
log = logging.getLogger(__name__ + '.ShowIdentityProvider')
@ -163,8 +163,8 @@ class ShowIdentityProvider(show.ShowOne):
parser = super(ShowIdentityProvider, self).get_parser(prog_name)
parser.add_argument(
'identity_provider',
metavar='<identity_provider>',
help='ID of the identity provider to be displayed',
metavar='<identity-provider-id>',
help='Identity provider ID to show',
)
return parser

22
openstackclient/volume/v1/volume.py
View File

@ -36,7 +36,7 @@ class CreateVolume(show.ShowOne):
parser.add_argument(
'name',
metavar='<name>',
help='Name of the volume',
help='Name of the new volume',
)
parser.add_argument(
'--size',
@ -48,7 +48,7 @@ class CreateVolume(show.ShowOne):
parser.add_argument(
'--snapshot-id',
metavar='<snapshot-id>',
help='ID of the snapshot',
help='Use <snapshot-id> as source of new volume',
)
parser.add_argument(
'--description',
@ -73,7 +73,7 @@ class CreateVolume(show.ShowOne):
parser.add_argument(
'--availability-zone',
metavar='<availability-zone>',
help='Availability zone to use',
help='Create new volume in <availability-zone>',
)
parser.add_argument(
'--property',
@ -85,12 +85,12 @@ class CreateVolume(show.ShowOne):
parser.add_argument(
'--image',
metavar='<image>',
help='Reference to a stored image',
help='Use <image> as source of new volume',
)
parser.add_argument(
'--source',
metavar='<volume>',
help='Source for volume clone',
help='Volume to clone (name or ID)',
)
return parser
@ -143,7 +143,7 @@ class CreateVolume(show.ShowOne):
class DeleteVolume(command.Command):
"""Delete volume"""
"""Delete a volume"""
log = logging.getLogger(__name__ + '.DeleteVolume')
@ -152,7 +152,7 @@ class DeleteVolume(command.Command):
parser.add_argument(
'volume',
metavar='<volume>',
help='Name or ID of volume to delete',
help='Volume to delete (name or ID)',
)
parser.add_argument(
'--force',
@ -271,7 +271,7 @@ class SetVolume(command.Command):
parser.add_argument(
'volume',
metavar='<volume>',
help='Name or ID of volume to change',
help='Volume to change (name or ID)',
)
parser.add_argument(
'--name',
@ -315,7 +315,7 @@ class SetVolume(command.Command):
class ShowVolume(show.ShowOne):
"""Show specific volume"""
"""Show volume details"""
log = logging.getLogger(__name__ + '.ShowVolume')
@ -324,7 +324,7 @@ class ShowVolume(show.ShowOne):
parser.add_argument(
'volume',
metavar='<volume>',
help='Name or ID of volume to display',
help='Volume to display (name or ID)',
)
return parser
@ -357,7 +357,7 @@ class UnsetVolume(command.Command):
parser.add_argument(
'volume',
metavar='<volume>',
help='Name or ID of volume to change',
help='Volume to change (name or ID)',
)
parser.add_argument(
'--property',