Fine tune some of the helps commands

try and add some consistency with the show and delete commands.

replace 'show x' with 'display x'
change 'delete a y' with just 'delete y'

Change-Id: I47dfa8ee23ac5c41b355796415eb515155832f65
This commit is contained in:
Steve Martinelli 2015-01-09 19:13:03 -05:00
parent 3b99c17894
commit 019c155e9b
35 changed files with 59 additions and 49 deletions

View File

@ -139,7 +139,7 @@ Set aggregate properties
aggregate show aggregate show
-------------- --------------
Show a specific aggregate Display aggregate details
.. program aggregate show .. program aggregate show
.. code:: bash .. code:: bash
@ -149,4 +149,4 @@ Show a specific aggregate
.. describe:: <aggregate> .. describe:: <aggregate>
Aggregate to show (name or ID) Aggregate to display (name or ID)

View File

@ -7,6 +7,8 @@ Identity v2
catalog list catalog list
------------ ------------
List services in the service catalog
.. code:: bash .. code:: bash
os catalog list os catalog list
@ -14,6 +16,8 @@ catalog list
catalog show catalog show
------------ ------------
Display service catalog details
.. code:: bash .. code:: bash
os catalog show os catalog show

View File

@ -24,7 +24,7 @@ Create new consumer
consumer delete consumer delete
--------------- ---------------
Delete a consumer Delete consumer
.. program:: consumer delete .. program:: consumer delete
.. code:: bash .. code:: bash

View File

@ -92,7 +92,7 @@ Save container contents locally
container show container show
-------------- --------------
Show container details Display container details
.. program:: container show .. program:: container show
.. code:: bash .. code:: bash

View File

@ -102,7 +102,7 @@ Set domain properties
domain show domain show
----------- -----------
Show domain details Display domain details
.. program:: domain show .. program:: domain show
.. code:: bash .. code:: bash

View File

@ -34,7 +34,7 @@ Create new federation protocol
federation protocol delete federation protocol delete
-------------------------- --------------------------
Delete a federation protocol Delete federation protocol
.. program:: federation protocol delete .. program:: federation protocol delete
.. code:: bash .. code:: bash

View File

@ -67,7 +67,7 @@ Create new flavor
flavor delete flavor delete
------------- -------------
Delete a flavor Delete flavor
.. program:: flavor delete .. program:: flavor delete
.. code:: bash .. code:: bash

View File

@ -38,7 +38,7 @@ Create new identity provider
identity provider delete identity provider delete
------------------------ ------------------------
Delete an identity provider Delete identity provider
.. program:: identity provider delete .. program:: identity provider delete
.. code:: bash .. code:: bash

View File

@ -30,7 +30,7 @@ Create new public key
keypair delete keypair delete
-------------- --------------
Delete a public key Delete public key
.. program keypair delete .. program keypair delete
.. code:: bash .. code:: bash
@ -55,7 +55,7 @@ List public key fingerprints
keypair show keypair show
------------ ------------
Show public key details Display public key details
.. program keypair show .. program keypair show
.. code:: bash .. code:: bash
@ -70,4 +70,4 @@ Show public key details
.. describe:: <key> .. describe:: <key>
Public key to show Public key to display

View File

@ -30,7 +30,7 @@ Create new mapping
mapping delete mapping delete
-------------- --------------
Delete a mapping Delete mapping
.. program:: mapping delete .. program:: mapping delete
.. code:: bash .. code:: bash

View File

@ -122,7 +122,7 @@ Save object locally
object show object show
----------- -----------
Show object details Display object details
.. program:: object show .. program:: object show
.. code:: bash .. code:: bash

View File

@ -149,6 +149,8 @@ Set project properties
project show project show
------------ ------------
Display project details
.. program:: project show .. program:: project show
.. code:: bash .. code:: bash
@ -165,4 +167,4 @@ project show
.. _project_show-project: .. _project_show-project:
.. describe:: <project> .. describe:: <project>
Project to show (name or ID) Project to display (name or ID)

View File

@ -95,7 +95,7 @@ Set region properties
.. _region_set-region-id: .. _region_set-region-id:
.. describe:: <region-id> .. describe:: <region-id>
Region ID to modify Region to modify
region show region show
----------- -----------
@ -111,4 +111,4 @@ Display region details
.. _region_show-region-id: .. _region_show-region-id:
.. describe:: <region-id> .. describe:: <region-id>
Region ID to display Region to display

View File

@ -142,7 +142,7 @@ Remove role from domain/project : user/group
.. describe:: <role> .. describe:: <role>
Role to remove from `<project>`:`<user>` (name or ID) Role to remove (name or ID)
role set role set
-------- --------
@ -169,6 +169,8 @@ Set role properties
role show role show
--------- ---------
Display role details
.. program:: role show .. program:: role show
.. code:: bash .. code:: bash
@ -177,4 +179,4 @@ role show
.. describe:: <role> .. describe:: <role>
Role to show (name or ID) Role to display (name or ID)

View File

@ -191,6 +191,8 @@ Set user properties
user show user show
--------- ---------
Display user details
.. program:: user show .. program:: user show
.. code:: bash .. code:: bash
@ -207,4 +209,4 @@ user show
.. _user_show-user: .. _user_show-user:
.. describe:: <user> .. describe:: <user>
User to show (name or ID) User to display (name or ID)

View File

@ -290,7 +290,7 @@ class SetAggregate(show.ShowOne):
class ShowAggregate(show.ShowOne): class ShowAggregate(show.ShowOne):
"""Show a specific aggregate""" """Display aggregate details"""
log = logging.getLogger(__name__ + '.ShowAggregate') log = logging.getLogger(__name__ + '.ShowAggregate')
@ -299,7 +299,7 @@ class ShowAggregate(show.ShowOne):
parser.add_argument( parser.add_argument(
'aggregate', 'aggregate',
metavar='<aggregate>', metavar='<aggregate>',
help='Aggregate to show (name or ID)', help='Aggregate to display (name or ID)',
) )
return parser return parser

View File

@ -125,7 +125,7 @@ class CreateFlavor(show.ShowOne):
class DeleteFlavor(command.Command): class DeleteFlavor(command.Command):
"""Delete a flavor""" """Delete flavor"""
log = logging.getLogger(__name__ + ".DeleteFlavor") log = logging.getLogger(__name__ + ".DeleteFlavor")

View File

@ -80,7 +80,7 @@ class CreateKeypair(show.ShowOne):
class DeleteKeypair(command.Command): class DeleteKeypair(command.Command):
"""Delete a public key""" """Delete public key"""
log = logging.getLogger(__name__ + '.DeleteKeypair') log = logging.getLogger(__name__ + '.DeleteKeypair')
@ -121,7 +121,7 @@ class ListKeypair(lister.Lister):
class ShowKeypair(show.ShowOne): class ShowKeypair(show.ShowOne):
"""Show public key details""" """Display public key details"""
log = logging.getLogger(__name__ + '.ShowKeypair') log = logging.getLogger(__name__ + '.ShowKeypair')
@ -130,7 +130,7 @@ class ShowKeypair(show.ShowOne):
parser.add_argument( parser.add_argument(
'name', 'name',
metavar='<key>', metavar='<key>',
help='Public key to show', help='Public key to display',
) )
parser.add_argument( parser.add_argument(
'--public-key', '--public-key',

View File

@ -59,7 +59,7 @@ class ListCatalog(lister.Lister):
class ShowCatalog(show.ShowOne): class ShowCatalog(show.ShowOne):
"""Show service catalog details""" """Display service catalog details"""
log = logging.getLogger(__name__ + '.ShowCatalog') log = logging.getLogger(__name__ + '.ShowCatalog')

View File

@ -241,7 +241,7 @@ class SetProject(command.Command):
class ShowProject(show.ShowOne): class ShowProject(show.ShowOne):
"""Show project details""" """Display project details"""
log = logging.getLogger(__name__ + '.ShowProject') log = logging.getLogger(__name__ + '.ShowProject')
@ -250,7 +250,7 @@ class ShowProject(show.ShowOne):
parser.add_argument( parser.add_argument(
'project', 'project',
metavar='<project>', metavar='<project>',
help=_('Project to show (name or ID)')) help=_('Project to display (name or ID)'))
return parser return parser
def take_action(self, parsed_args): def take_action(self, parsed_args):

View File

@ -226,7 +226,7 @@ class ListUserRole(lister.Lister):
class RemoveRole(command.Command): class RemoveRole(command.Command):
"""Remove role from project:user""" """Remove role from project : user"""
log = logging.getLogger(__name__ + '.RemoveRole') log = logging.getLogger(__name__ + '.RemoveRole')
@ -235,7 +235,7 @@ class RemoveRole(command.Command):
parser.add_argument( parser.add_argument(
'role', 'role',
metavar='<role>', metavar='<role>',
help=_('Role to remove from <project>:<user> (name or ID)'), help=_('Role to remove (name or ID)'),
) )
parser.add_argument( parser.add_argument(
'--project', '--project',
@ -267,7 +267,7 @@ class RemoveRole(command.Command):
class ShowRole(show.ShowOne): class ShowRole(show.ShowOne):
"""Show single role""" """Display role details"""
log = logging.getLogger(__name__ + '.ShowRole') log = logging.getLogger(__name__ + '.ShowRole')
@ -276,7 +276,7 @@ class ShowRole(show.ShowOne):
parser.add_argument( parser.add_argument(
'role', 'role',
metavar='<role>', metavar='<role>',
help=_('Role to show (name or ID)'), help=_('Role to display (name or ID)'),
) )
return parser return parser

View File

@ -144,7 +144,7 @@ class ListService(lister.Lister):
class ShowService(show.ShowOne): class ShowService(show.ShowOne):
"""Show service details""" """Display service details"""
log = logging.getLogger(__name__ + '.ShowService') log = logging.getLogger(__name__ + '.ShowService')

View File

@ -349,7 +349,7 @@ class SetUser(command.Command):
class ShowUser(show.ShowOne): class ShowUser(show.ShowOne):
"""Show user details""" """Display user details"""
log = logging.getLogger(__name__ + '.ShowUser') log = logging.getLogger(__name__ + '.ShowUser')

View File

@ -51,7 +51,7 @@ class CreateConsumer(show.ShowOne):
class DeleteConsumer(command.Command): class DeleteConsumer(command.Command):
"""Delete a consumer""" """Delete consumer"""
log = logging.getLogger(__name__ + '.DeleteConsumer') log = logging.getLogger(__name__ + '.DeleteConsumer')

View File

@ -187,7 +187,7 @@ class SetDomain(command.Command):
class ShowDomain(show.ShowOne): class ShowDomain(show.ShowOne):
"""Show domain details""" """Display domain details"""
log = logging.getLogger(__name__ + '.ShowDomain') log = logging.getLogger(__name__ + '.ShowDomain')

View File

@ -69,7 +69,7 @@ class CreateProtocol(show.ShowOne):
class DeleteProtocol(command.Command): class DeleteProtocol(command.Command):
"""Delete a federation protocol""" """Delete federation protocol"""
log = logging.getLogger(__name__ + '.DeleteProtocol') log = logging.getLogger(__name__ + '.DeleteProtocol')

View File

@ -69,7 +69,7 @@ class CreateIdentityProvider(show.ShowOne):
class DeleteIdentityProvider(command.Command): class DeleteIdentityProvider(command.Command):
"""Delete an identity provider""" """Delete identity provider"""
log = logging.getLogger(__name__ + '.DeleteIdentityProvider') log = logging.getLogger(__name__ + '.DeleteIdentityProvider')

View File

@ -112,7 +112,7 @@ class CreateMapping(show.ShowOne, _RulesReader):
class DeleteMapping(command.Command): class DeleteMapping(command.Command):
"""Delete a mapping""" """Delete mapping"""
log = logging.getLogger(__name__ + '.DeleteMapping') log = logging.getLogger(__name__ + '.DeleteMapping')

View File

@ -298,7 +298,7 @@ class SetProject(command.Command):
class ShowProject(show.ShowOne): class ShowProject(show.ShowOne):
"""Show project command""" """Display project details"""
log = logging.getLogger(__name__ + '.ShowProject') log = logging.getLogger(__name__ + '.ShowProject')
@ -307,7 +307,7 @@ class ShowProject(show.ShowOne):
parser.add_argument( parser.add_argument(
'project', 'project',
metavar='<project>', metavar='<project>',
help='Name or ID of project to display', help='Project to display (name or ID)',
) )
parser.add_argument( parser.add_argument(
'--domain', '--domain',

View File

@ -138,7 +138,7 @@ class SetRegion(command.Command):
parser.add_argument( parser.add_argument(
'region', 'region',
metavar='<region-id>', metavar='<region-id>',
help=_('Region ID to modify'), help=_('Region to modify'),
) )
parser.add_argument( parser.add_argument(
'--parent-region', '--parent-region',
@ -188,7 +188,7 @@ class ShowRegion(show.ShowOne):
parser.add_argument( parser.add_argument(
'region', 'region',
metavar='<region-id>', metavar='<region-id>',
help=_('Region ID to display'), help=_('Region to display'),
) )
return parser return parser

View File

@ -467,7 +467,7 @@ class SetRole(command.Command):
class ShowRole(show.ShowOne): class ShowRole(show.ShowOne):
"""Show single role""" """Display role details"""
log = logging.getLogger(__name__ + '.ShowRole') log = logging.getLogger(__name__ + '.ShowRole')
@ -476,7 +476,7 @@ class ShowRole(show.ShowOne):
parser.add_argument( parser.add_argument(
'role', 'role',
metavar='<role>', metavar='<role>',
help='Role to show (name or ID)', help='Role to display (name or ID)',
) )
return parser return parser

View File

@ -194,7 +194,7 @@ class SetService(command.Command):
class ShowService(show.ShowOne): class ShowService(show.ShowOne):
"""Show service details""" """Display service details"""
log = logging.getLogger(__name__ + '.ShowService') log = logging.getLogger(__name__ + '.ShowService')

View File

@ -422,7 +422,7 @@ class SetPasswordUser(command.Command):
class ShowUser(show.ShowOne): class ShowUser(show.ShowOne):
"""Show user details""" """Display user details"""
log = logging.getLogger(__name__ + '.ShowUser') log = logging.getLogger(__name__ + '.ShowUser')

View File

@ -179,7 +179,7 @@ class SaveContainer(command.Command):
class ShowContainer(show.ShowOne): class ShowContainer(show.ShowOne):
"""Show container details""" """Display container details"""
log = logging.getLogger(__name__ + '.ShowContainer') log = logging.getLogger(__name__ + '.ShowContainer')

View File

@ -222,7 +222,7 @@ class SaveObject(command.Command):
class ShowObject(show.ShowOne): class ShowObject(show.ShowOne):
"""Show object details""" """Display object details"""
log = logging.getLogger(__name__ + '.ShowObject') log = logging.getLogger(__name__ + '.ShowObject')