openstack
/
python-openstackclient
Code Issues Proposed changes

Fix some help strings 

This fixes some errors and inconsistencies I found reviewing the
help strings:
* Capitalize help strings
* Add missing space between words (in multi-line strings)
* Improve wording

Change-Id: I2fb31ab4191c330146e31c1a9651115a6657769a
This commit is contained in:
Andreas Jaeger 2014-02-21 19:22:32 +01:00
parent 2cae50c442
commit 5043293156
15 changed files with 32 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -136,7 +136,7 @@ class SetAgent(show.ShowOne):
parser.add_argument(
"id",
metavar="<id>",
help="ID of the agent build")
help="ID of the agent")
parser.add_argument(
"version",
metavar="<version>",

24
openstackclient/compute/v2/server.py
View File

@ -483,40 +483,40 @@ class ListServer(lister.Lister):
parser.add_argument(
'--reservation-id',
metavar='<reservation-id>',
help='only return instances that match the reservation')
help='Only return instances that match the reservation')
parser.add_argument(
'--ip',
metavar='<ip-address-regex>',
help='regular expression to match IP address')
help='Regular expression to match IP addresses')
parser.add_argument(
'--ip6',
metavar='<ip-address-regex>',
help='regular expression to match IPv6 address')
help='Regular expression to match IPv6 addresses')
parser.add_argument(
'--name',
metavar='<name>',
help='regular expression to match name')
help='Regular expression to match names')
parser.add_argument(
'--status',
metavar='<status>',
# FIXME(dhellmann): Add choices?
help='search by server status')
help='Search by server status')
parser.add_argument(
'--flavor',
metavar='<flavor>',
help='search by flavor ID')
help='Search by flavor ID')
parser.add_argument(
'--image',
metavar='<image>',
help='search by image ID')
help='Search by image ID')
parser.add_argument(
'--host',
metavar='<hostname>',
help='search by hostname')
help='Search by hostname')
parser.add_argument(
'--instance-name',
metavar='<server-name>',
help='regular expression to match instance name (admin only)')
help='Regular expression to match instance name (admin only)')
parser.add_argument(
'--all-projects',
action='store_true',
@ -526,7 +526,7 @@ class ListServer(lister.Lister):
'--long',
action='store_true',
default=False,
help='Additional fields are listed in output')
help='List additional fields in output')
return parser
def take_action(self, parsed_args):
@ -1181,14 +1181,14 @@ class SshServer(command.Command):
dest='ipv4',
action='store_true',
default=False,
help='Use only IPv4 addresses only',
help='Use only IPv4 addresses',
)
ip_group.add_argument(
'-6',
dest='ipv6',
action='store_true',
default=False,
help='Use only IPv6 addresses only',
help='Use only IPv6 addresses',
)
type_group = parser.add_mutually_exclusive_group()
type_group.add_argument(

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

@ -35,7 +35,7 @@ class ListUsage(lister.Lister):
"--start",
metavar="<start>",
default=None,
help="Usage range start date ex 2012-01-20"
help="Usage range start date, ex 2012-01-20"
" (default: 4 weeks ago)."
)
parser.add_argument(

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

@ -106,7 +106,7 @@ class ListEndpoint(lister.Lister):
'--long',
action='store_true',
default=False,
help='Additional fields are listed in output')
help='List additional fields in output')
return parser
def take_action(self, parsed_args):

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

@ -104,7 +104,7 @@ class ListService(lister.Lister):
'--long',
action='store_true',
default=False,
help='Additional fields are listed in output')
help='List additional fields in output')
return parser
def take_action(self, parsed_args):

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

@ -143,7 +143,7 @@ class ListUser(lister.Lister):
'--long',
action='store_true',
default=False,
help='Additional fields are listed in output')
help='List additional fields in output')
return parser
def take_action(self, parsed_args):

2
openstackclient/identity/v3/endpoint.py
View File

@ -120,7 +120,7 @@ class ListEndpoint(lister.Lister):
'--long',
action='store_true',
default=False,
help='Additional fields are listed in output')
help='List additional fields in output')
return parser
def take_action(self, parsed_args):

2
openstackclient/identity/v3/group.py
View File

@ -197,7 +197,7 @@ class ListGroup(lister.Lister):
'--long',
action='store_true',
default=False,
help='Additional fields are listed in output',
help='List additional fields in output',
)
return parser

2
openstackclient/identity/v3/policy.py
View File

@ -37,7 +37,7 @@ class CreatePolicy(show.ShowOne):
'--type',
metavar='<policy-type>',
default="application/json",
help='New MIME Type of the policy blob - i.e.: application/json',
help='New MIME type of the policy blob - i.e.: application/json',
)
parser.add_argument(
'blob_file',

6
openstackclient/identity/v3/token.py
View File

@ -213,12 +213,12 @@ class DeleteAccessToken(command.Command):
parser.add_argument(
'user',
metavar='<user>',
help='Name or Id of user',
help='Name or ID of user',
)
parser.add_argument(
'access_key',
metavar='<access-key>',
help='Access Token to be deleted',
help='Access token to be deleted',
)
return parser
@ -243,7 +243,7 @@ class ListAccessToken(lister.Lister):
parser.add_argument(
'user',
metavar='<user>',
help='Name or Id of user',
help='Name or ID of user',
)
return parser

2
openstackclient/identity/v3/user.py
View File

@ -174,7 +174,7 @@ class ListUser(lister.Lister):
'--long',
action='store_true',
default=False,
help='Additional fields are listed in output',
help='List additional fields in output',
)
return parser

10
openstackclient/shell.py
View File

@ -117,7 +117,7 @@ class OpenStackShell(app.App):
action='store_true',
dest='deferred_help',
default=False,
help="show this help message and exit",
help="Show this help message and exit",
)
def run(self, argv):
@ -147,21 +147,21 @@ class OpenStackShell(app.App):
'--os-domain-name',
metavar='<auth-domain-name>',
default=env('OS_DOMAIN_NAME'),
help='Domain name of the requested domain-level'
help='Domain name of the requested domain-level '
'authorization scope (Env: OS_DOMAIN_NAME)',
)
parser.add_argument(
'--os-domain-id',
metavar='<auth-domain-id>',
default=env('OS_DOMAIN_ID'),
help='Domain ID of the requested domain-level'
help='Domain ID of the requested domain-level '
'authorization scope (Env: OS_DOMAIN_ID)',
)
parser.add_argument(
'--os-project-name',
metavar='<auth-project-name>',
default=env('OS_PROJECT_NAME', default=env('OS_TENANT_NAME')),
help='Project name of the requested project-level'
help='Project name of the requested project-level '
'authorization scope (Env: OS_PROJECT_NAME)',
)
parser.add_argument(
@ -174,7 +174,7 @@ class OpenStackShell(app.App):
'--os-project-id',
metavar='<auth-project-id>',
default=env('OS_PROJECT_ID', default=env('OS_TENANT_ID')),
help='Project ID of the requested project-level'
help='Project ID of the requested project-level '
'authorization scope (Env: OS_PROJECT_ID)',
)
parser.add_argument(

2
openstackclient/volume/v1/backup.py
View File

@ -41,7 +41,7 @@ class CreateBackup(show.ShowOne):
'--container',
metavar='<container>',
required=False,
help='Optional Backup container name.',
help='Optional backup container name.',
)
parser.add_argument(
'--name',

2
openstackclient/volume/v1/type.py
View File

@ -100,7 +100,7 @@ class ListVolumeType(lister.Lister):
'--long',
action='store_true',
default=False,
help='Additional fields are listed in output')
help='List additional fields in output')
return parser
def take_action(self, parsed_args):

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

@ -68,7 +68,7 @@ class CreateVolume(show.ShowOne):
parser.add_argument(
'--project',
metavar='<project>',
help='Specify a diffeent project (admin only)',
help='Specify a different project (admin only)',
)
parser.add_argument(
'--availability-zone',