openstack/python-openstackclient
Code Issues Proposed changes

replace metavar "volume-id" with "volume" to avoid ambiguity

Browse Source 
The help message of command "openstack volume show" accepts either
volume-name or volume-ID. But the metavar is "volume-id" as below.
It can easily lead to misunderstanding.

usage: openstack volume show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>]
                             [--noindent][--prefix PREFIX]
                             <volume-id>

Change-Id: I57576ea23868b1026cf268be69b39e98a53aafd4
This commit is contained in:
Shu Yingya 2016-09-21 12:16:35 +08:00
parent ccd2d658d1
commit b30a7b795f
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -490,7 +490,7 @@ class ShowVolume(command.ShowOne):
parser = super(ShowVolume, self).get_parser(prog_name) parser = super(ShowVolume, self).get_parser(prog_name)
parser.add_argument( parser.add_argument(
'volume', 'volume',
metavar="<volume-id>", metavar="<volume>",
help=_("Volume to display (name or ID)") help=_("Volume to display (name or ID)")
) )
return parser return parser