openstack/python-cinderclient
Code Issues Proposed changes

Remove "OPTIONAL:" from optional argument help text (v2)

Browse Source 
All arguments starting with '--' are optional and listed
under the 'Optional arguments:' header by argparse.  Remove
the extra note shown for each argument.

This mirrors the previous change which cleaned this up for v1:
811af8f Remove "OPTIONAL:" from optional argument help text

Change-Id: Ie8e9544c1544ff5403f1c29e83d528d896957899
This commit is contained in:
Eric Harney
2015-04-22 09:46:15 -04:00
parent 8ba6242d64
commit 27a7e8f3b0
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
cinderclient/v2/shell.py
View File

@@ -153,30 +153,30 @@ def _extract_metadata(args):
@utils.arg('--name', @utils.arg('--name',
metavar='<name>', metavar='<name>',
default=None, default=None,
help='Filters results by a name. OPTIONAL: Default=None.') help='Filters results by a name. Default=None.')
@utils.arg('--display-name', @utils.arg('--display-name',
help=argparse.SUPPRESS) help=argparse.SUPPRESS)
@utils.arg('--status', @utils.arg('--status',
metavar='<status>', metavar='<status>',
default=None, default=None,
help='Filters results by a status. OPTIONAL: Default=None.') help='Filters results by a status. Default=None.')
@utils.arg('--metadata', @utils.arg('--metadata',
type=str, type=str,
nargs='*', nargs='*',
metavar='<key=value>', metavar='<key=value>',
default=None, default=None,
help='Filters results by a metadata key and value pair. ' help='Filters results by a metadata key and value pair. '
'OPTIONAL: Default=None.') 'Default=None.')
@utils.arg('--marker', @utils.arg('--marker',
metavar='<marker>', metavar='<marker>',
default=None, default=None,
help='Begin returning volumes that appear later in the volume ' help='Begin returning volumes that appear later in the volume '
'list than that represented by this volume id. ' 'list than that represented by this volume id. '
'OPTIONAL: Default=None.') 'Default=None.')
@utils.arg('--limit', @utils.arg('--limit',
metavar='<limit>', metavar='<limit>',
default=None, default=None,
help='Maximum number of volumes to return. OPTIONAL: Default=None.') help='Maximum number of volumes to return. Default=None.')
@utils.arg('--sort_key', @utils.arg('--sort_key',
metavar='<sort_key>', metavar='<sort_key>',
default=None, default=None,
@@ -190,7 +190,7 @@ def _extract_metadata(args):
default=None, default=None,
help=(('Comma-separated list of sort keys and directions in the ' help=(('Comma-separated list of sort keys and directions in the '
'form of <key>[:<asc|desc>]. ' 'form of <key>[:<asc|desc>]. '
'Valid keys: %s. OPTIONAL: ' 'Valid keys: %s. '
'Default=None.') % ', '.join(volumes.SORT_KEY_VALUES))) 'Default=None.') % ', '.join(volumes.SORT_KEY_VALUES)))
@utils.arg('--tenant', @utils.arg('--tenant',
type=str, type=str,