openstack
/
python-glanceclient
Code Issues Proposed changes

Improve help strings 

Make help strings consistent to use "." at end of string.

Fix capitalization of API in one help string.

Change-Id: I7cc5289d881c5e58aad9c69b4668584cdeb0b376
This commit is contained in:
Andreas Jaeger 2014-02-18 13:28:06 +01:00
parent 8b76817c17
commit 2c53246184
4 changed files with 36 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
glanceclient/shell.py
View File

@ -60,7 +60,7 @@ class OpenStackImagesShell(object):
parser.add_argument('-d', '--debug',
default=bool(utils.env('GLANCECLIENT_DEBUG')),
action='store_true',
help='Defaults to env[GLANCECLIENT_DEBUG]')
help='Defaults to env[GLANCECLIENT_DEBUG].')
parser.add_argument('-v', '--verbose',
default=False, action="store_true",
@ -69,9 +69,9 @@ class OpenStackImagesShell(object):
parser.add_argument('--get-schema',
default=False, action="store_true",
dest='get_schema',
help='Force retrieving the schema used to generate'
' portions of the help text rather than using'
' a cached copy. Ignored with api version 1')
help='Ignores cached copy and forces retrieval '
'of schema that generates portions of the '
'help text. Ignored with API version 1.')
parser.add_argument('-k', '--insecure',
default=False,
@ -152,7 +152,7 @@ class OpenStackImagesShell(object):
parser.add_argument('--os-username',
default=utils.env('OS_USERNAME'),
help='Defaults to env[OS_USERNAME]')
help='Defaults to env[OS_USERNAME].')
parser.add_argument('--os_username',
help=argparse.SUPPRESS)
@ -164,7 +164,7 @@ class OpenStackImagesShell(object):
parser.add_argument('--os-password',
default=utils.env('OS_PASSWORD'),
help='Defaults to env[OS_PASSWORD]')
help='Defaults to env[OS_PASSWORD].')
parser.add_argument('--os_password',
help=argparse.SUPPRESS)
@ -176,14 +176,14 @@ class OpenStackImagesShell(object):
parser.add_argument('--os-tenant-id',
default=utils.env('OS_TENANT_ID'),
help='Defaults to env[OS_TENANT_ID]')
help='Defaults to env[OS_TENANT_ID].')
parser.add_argument('--os_tenant_id',
help=argparse.SUPPRESS)
parser.add_argument('--os-tenant-name',
default=utils.env('OS_TENANT_NAME'),
help='Defaults to env[OS_TENANT_NAME]')
help='Defaults to env[OS_TENANT_NAME].')
parser.add_argument('--os_tenant_name',
help=argparse.SUPPRESS)
@ -195,7 +195,7 @@ class OpenStackImagesShell(object):
parser.add_argument('--os-auth-url',
default=utils.env('OS_AUTH_URL'),
help='Defaults to env[OS_AUTH_URL]')
help='Defaults to env[OS_AUTH_URL].')
parser.add_argument('--os_auth_url',
help=argparse.SUPPRESS)
@ -207,7 +207,7 @@ class OpenStackImagesShell(object):
parser.add_argument('--os-region-name',
default=utils.env('OS_REGION_NAME'),
help='Defaults to env[OS_REGION_NAME]')
help='Defaults to env[OS_REGION_NAME].')
parser.add_argument('--os_region_name',
help=argparse.SUPPRESS)
@ -219,7 +219,7 @@ class OpenStackImagesShell(object):
parser.add_argument('--os-auth-token',
default=utils.env('OS_AUTH_TOKEN'),
help='Defaults to env[OS_AUTH_TOKEN]')
help='Defaults to env[OS_AUTH_TOKEN].')
parser.add_argument('--os_auth_token',
help=argparse.SUPPRESS)
@ -231,7 +231,7 @@ class OpenStackImagesShell(object):
parser.add_argument('--os-image-url',
default=utils.env('OS_IMAGE_URL'),
help='Defaults to env[OS_IMAGE_URL]')
help='Defaults to env[OS_IMAGE_URL].')
parser.add_argument('--os_image_url',
help=argparse.SUPPRESS)
@ -244,21 +244,21 @@ class OpenStackImagesShell(object):
parser.add_argument('--os-image-api-version',
default=utils.env('OS_IMAGE_API_VERSION',
default='1'),
help='Defaults to env[OS_IMAGE_API_VERSION] or 1')
help='Defaults to env[OS_IMAGE_API_VERSION] or 1.')
parser.add_argument('--os_image_api_version',
help=argparse.SUPPRESS)
parser.add_argument('--os-service-type',
default=utils.env('OS_SERVICE_TYPE'),
help='Defaults to env[OS_SERVICE_TYPE]')
help='Defaults to env[OS_SERVICE_TYPE].')
parser.add_argument('--os_service_type',
help=argparse.SUPPRESS)
parser.add_argument('--os-endpoint-type',
default=utils.env('OS_ENDPOINT_TYPE'),
help='Defaults to env[OS_ENDPOINT_TYPE]')
help='Defaults to env[OS_ENDPOINT_TYPE].')
parser.add_argument('--os_endpoint_type',
help=argparse.SUPPRESS)
@ -479,7 +479,7 @@ class OpenStackImagesShell(object):
raise exc.CommandError("Invalid OpenStack Identity credentials.")
@utils.arg('command', metavar='<subcommand>', nargs='?',
help='Display help for <subcommand>')
help='Display help for <subcommand>.')
def do_help(self, args):
"""
Display help about this program or one of its subcommands.

8
glanceclient/v1/legacy_shell.py
View File

@ -273,9 +273,9 @@ def _get_images(gc, args):
@utils.arg('--limit', dest="limit", metavar="LIMIT", default=10,
type=int, help="Page size to use while requesting image metadata")
type=int, help="Page size for image metadata requests.")
@utils.arg('--marker', dest="marker", metavar="MARKER",
default=None, help="Image index after which to begin pagination")
default=None, help="Image index after which to begin pagination.")
@utils.arg('--sort_key', dest="sort_key", metavar="KEY",
help="Sort results by this image attribute.")
@utils.arg('--sort_dir', dest="sort_dir", metavar="[desc|asc]",
@ -306,9 +306,9 @@ def do_index(gc, args):
@utils.arg('--limit', dest="limit", metavar="LIMIT", default=10,
type=int, help="Page size to use while requesting image metadata")
type=int, help="Page size for image metadata requests.")
@utils.arg('--marker', dest="marker", metavar="MARKER",
default=None, help="Image index after which to begin pagination")
default=None, help="Image index after which to begin pagination.")
@utils.arg('--sort_key', dest="sort_key", metavar="KEY",
help="Sort results by this image attribute.")
@utils.arg('--sort_dir', dest="sort_dir", metavar="[desc|asc]",

4
glanceclient/v1/shell.py
View File

@ -375,9 +375,9 @@ def do_member_create(gc, args):
@utils.arg('image', metavar='<IMAGE>',
help='Image from which to remove member')
help='Image from which to remove member.')
@utils.arg('tenant_id', metavar='<TENANT_ID>',
help='Tenant to remove as member')
help='Tenant to remove as member.')
def do_member_delete(gc, args):
"""Remove a shared image from a tenant."""
image_id = utils.find_resource(gc.images, args.image).id

28
glanceclient/v2/shell.py
View File

@ -66,7 +66,7 @@ def do_image_create(gc, args):
default=[], help=('Arbitrary property to associate with image.'
' May be used multiple times.'))
@utils.arg('--remove-property', metavar="key", action='append', default=[],
help="Name of arbitrary property to remove from the image")
help="Name of arbitrary property to remove from the image.")
def do_image_update(gc, args):
"""Update an existing image."""
schema = gc.schemas.get("image")
@ -100,7 +100,7 @@ def do_image_update(gc, args):
@utils.arg('--owner', metavar='<OWNER>',
help='Display images owned by <OWNER>.')
@utils.arg('--checksum', metavar='<CHECKSUM>',
help='Display images matching the checksum')
help='Displays images that match the checksum.')
@utils.arg('--tag', metavar='<TAG>', action='append',
help="Filter images by an user-defined tag.")
def do_image_list(gc, args):
@ -141,11 +141,11 @@ def do_member_list(gc, args):
@utils.arg('image_id', metavar='<IMAGE_ID>',
help='Image from which to remove member')
help='Image from which to remove member.')
@utils.arg('member_id', metavar='<MEMBER_ID>',
help='Tenant to remove as member')
help='Tenant to remove as member.')
def do_member_delete(gc, args):
"""Delete image member"""
"""Delete image member."""
if not (args.image_id and args.member_id):
utils.exit('Unable to delete member. Specify image_id and member_id')
else:
@ -153,11 +153,11 @@ def do_member_delete(gc, args):
@utils.arg('image_id', metavar='<IMAGE_ID>',
help='Image from which to update member')
help='Image from which to update member.')
@utils.arg('member_id', metavar='<MEMBER_ID>',
help='Tenant to update')
help='Tenant to update.')
@utils.arg('member_status', metavar='<MEMBER_STATUS>',
help='Updated status of member')
help='Updated status of member.')
def do_member_update(gc, args):
"""Update the status of a member for a given image."""
if not (args.image_id and args.member_id and args.member_status):
@ -172,9 +172,9 @@ def do_member_update(gc, args):
@utils.arg('image_id', metavar='<IMAGE_ID>',
help='Image on which to create member')
help='Image with which to create member.')
@utils.arg('member_id', metavar='<MEMBER_ID>',
help='Tenant to add as member')
help='Tenant to add as member.')
def do_member_create(gc, args):
"""Create member for a given image."""
if not (args.image_id and args.member_id):
@ -238,9 +238,9 @@ def do_image_delete(gc, args):
@utils.arg('image_id', metavar='<IMAGE_ID>',
help='Image to be updated with the given tag')
help='Image to be updated with the given tag.')
@utils.arg('tag_value', metavar='<TAG_VALUE>',
help='Value of the tag')
help='Value of the tag.')
def do_image_tag_update(gc, args):
"""Update an image with the given tag."""
if not (args.image_id and args.tag_value):
@ -254,9 +254,9 @@ def do_image_tag_update(gc, args):
@utils.arg('image_id', metavar='<IMAGE_ID>',
help='Image whose tag to be deleted')
help='ID of the image from which to delete tag.')
@utils.arg('tag_value', metavar='<TAG_VALUE>',
help='Value of the tag')
help='Value of the tag.')
def do_image_tag_delete(gc, args):
"""Delete the tag associated with the given image."""
if not (args.image_id and args.tag_value):