From 50432931562ca697a2b88db2bb2f0b1da91fb28a Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.de>
Date: Fri, 21 Feb 2014 19:22:32 +0100
Subject: [PATCH] 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
---
openstackclient/compute/v2/agent.py | 2 +-
openstackclient/compute/v2/server.py | 24 +++++++++++------------
openstackclient/compute/v2/usage.py | 2 +-
openstackclient/identity/v2_0/endpoint.py | 2 +-
openstackclient/identity/v2_0/service.py | 2 +-
openstackclient/identity/v2_0/user.py | 2 +-
openstackclient/identity/v3/endpoint.py | 2 +-
openstackclient/identity/v3/group.py | 2 +-
openstackclient/identity/v3/policy.py | 2 +-
openstackclient/identity/v3/token.py | 6 +++---
openstackclient/identity/v3/user.py | 2 +-
openstackclient/shell.py | 10 +++++-----
openstackclient/volume/v1/backup.py | 2 +-
openstackclient/volume/v1/type.py | 2 +-
openstackclient/volume/v1/volume.py | 2 +-
15 files changed, 32 insertions(+), 32 deletions(-)
diff --git a/openstackclient/compute/v2/agent.py b/openstackclient/compute/v2/agent.py
index b79ebbe761..c8fb6ccc0d 100644
--- a/openstackclient/compute/v2/agent.py
+++ b/openstackclient/compute/v2/agent.py
@@ -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>",
diff --git a/openstackclient/compute/v2/server.py b/openstackclient/compute/v2/server.py
index 87f5f6896d..808741fdca 100644
--- a/openstackclient/compute/v2/server.py
+++ b/openstackclient/compute/v2/server.py
@@ -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(
diff --git a/openstackclient/compute/v2/usage.py b/openstackclient/compute/v2/usage.py
index 3083576945..1dfe8c0ae4 100644
--- a/openstackclient/compute/v2/usage.py
+++ b/openstackclient/compute/v2/usage.py
@@ -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(
diff --git a/openstackclient/identity/v2_0/endpoint.py b/openstackclient/identity/v2_0/endpoint.py
index 5a050fa190..0319c2680a 100644
--- a/openstackclient/identity/v2_0/endpoint.py
+++ b/openstackclient/identity/v2_0/endpoint.py
@@ -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):
diff --git a/openstackclient/identity/v2_0/service.py b/openstackclient/identity/v2_0/service.py
index 92d1e09915..ea45f63431 100644
--- a/openstackclient/identity/v2_0/service.py
+++ b/openstackclient/identity/v2_0/service.py
@@ -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):
diff --git a/openstackclient/identity/v2_0/user.py b/openstackclient/identity/v2_0/user.py
index 371c45a998..55ba5ab64f 100644
--- a/openstackclient/identity/v2_0/user.py
+++ b/openstackclient/identity/v2_0/user.py
@@ -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):
diff --git a/openstackclient/identity/v3/endpoint.py b/openstackclient/identity/v3/endpoint.py
index 43da07aaad..e0b1f1a3cf 100644
--- a/openstackclient/identity/v3/endpoint.py
+++ b/openstackclient/identity/v3/endpoint.py
@@ -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):
diff --git a/openstackclient/identity/v3/group.py b/openstackclient/identity/v3/group.py
index b5d24ef5f8..6c059b5df7 100644
--- a/openstackclient/identity/v3/group.py
+++ b/openstackclient/identity/v3/group.py
@@ -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
diff --git a/openstackclient/identity/v3/policy.py b/openstackclient/identity/v3/policy.py
index cdbb1cf299..a760d8cdd8 100644
--- a/openstackclient/identity/v3/policy.py
+++ b/openstackclient/identity/v3/policy.py
@@ -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',
diff --git a/openstackclient/identity/v3/token.py b/openstackclient/identity/v3/token.py
index 68f9ffef47..3cc78cd7a8 100644
--- a/openstackclient/identity/v3/token.py
+++ b/openstackclient/identity/v3/token.py
@@ -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
diff --git a/openstackclient/identity/v3/user.py b/openstackclient/identity/v3/user.py
index 54ffe561a3..2cb1b4d2f5 100644
--- a/openstackclient/identity/v3/user.py
+++ b/openstackclient/identity/v3/user.py
@@ -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
diff --git a/openstackclient/shell.py b/openstackclient/shell.py
index 76cc3c6a90..49307992c7 100644
--- a/openstackclient/shell.py
+++ b/openstackclient/shell.py
@@ -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(
diff --git a/openstackclient/volume/v1/backup.py b/openstackclient/volume/v1/backup.py
index dbf6eb7370..ac34749baf 100644
--- a/openstackclient/volume/v1/backup.py
+++ b/openstackclient/volume/v1/backup.py
@@ -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',
diff --git a/openstackclient/volume/v1/type.py b/openstackclient/volume/v1/type.py
index ecf22781b4..edacb397e5 100644
--- a/openstackclient/volume/v1/type.py
+++ b/openstackclient/volume/v1/type.py
@@ -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):
diff --git a/openstackclient/volume/v1/volume.py b/openstackclient/volume/v1/volume.py
index 0253bc1dad..928ed76be0 100644
--- a/openstackclient/volume/v1/volume.py
+++ b/openstackclient/volume/v1/volume.py
@@ -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',