From 019c155e9b308dab002f23064b969452bc3d7a89 Mon Sep 17 00:00:00 2001 From: Steve Martinelli Date: Fri, 9 Jan 2015 19:13:03 -0500 Subject: [PATCH] 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 --- doc/source/command-objects/aggregate.rst | 4 ++-- doc/source/command-objects/catalog.rst | 4 ++++ doc/source/command-objects/consumer.rst | 2 +- doc/source/command-objects/container.rst | 2 +- doc/source/command-objects/domain.rst | 2 +- doc/source/command-objects/federation-protocol.rst | 2 +- doc/source/command-objects/flavor.rst | 2 +- doc/source/command-objects/identity-provider.rst | 2 +- doc/source/command-objects/keypair.rst | 6 +++--- doc/source/command-objects/mapping.rst | 2 +- doc/source/command-objects/object.rst | 2 +- doc/source/command-objects/project.rst | 4 +++- doc/source/command-objects/region.rst | 4 ++-- doc/source/command-objects/role.rst | 6 ++++-- doc/source/command-objects/user.rst | 4 +++- openstackclient/compute/v2/aggregate.py | 4 ++-- openstackclient/compute/v2/flavor.py | 2 +- openstackclient/compute/v2/keypair.py | 6 +++--- openstackclient/identity/v2_0/catalog.py | 2 +- openstackclient/identity/v2_0/project.py | 4 ++-- openstackclient/identity/v2_0/role.py | 8 ++++---- openstackclient/identity/v2_0/service.py | 2 +- openstackclient/identity/v2_0/user.py | 2 +- openstackclient/identity/v3/consumer.py | 2 +- openstackclient/identity/v3/domain.py | 2 +- openstackclient/identity/v3/federation_protocol.py | 2 +- openstackclient/identity/v3/identity_provider.py | 2 +- openstackclient/identity/v3/mapping.py | 2 +- openstackclient/identity/v3/project.py | 4 ++-- openstackclient/identity/v3/region.py | 4 ++-- openstackclient/identity/v3/role.py | 4 ++-- openstackclient/identity/v3/service.py | 2 +- openstackclient/identity/v3/user.py | 2 +- openstackclient/object/v1/container.py | 2 +- openstackclient/object/v1/object.py | 2 +- 35 files changed, 59 insertions(+), 49 deletions(-) diff --git a/doc/source/command-objects/aggregate.rst b/doc/source/command-objects/aggregate.rst index 6497f63274..2a40d23440 100644 --- a/doc/source/command-objects/aggregate.rst +++ b/doc/source/command-objects/aggregate.rst @@ -139,7 +139,7 @@ Set aggregate properties aggregate show -------------- -Show a specific aggregate +Display aggregate details .. program aggregate show .. code:: bash @@ -149,4 +149,4 @@ Show a specific aggregate .. describe:: - Aggregate to show (name or ID) + Aggregate to display (name or ID) diff --git a/doc/source/command-objects/catalog.rst b/doc/source/command-objects/catalog.rst index 99746dd716..4e67f3a4e3 100644 --- a/doc/source/command-objects/catalog.rst +++ b/doc/source/command-objects/catalog.rst @@ -7,6 +7,8 @@ Identity v2 catalog list ------------ +List services in the service catalog + .. code:: bash os catalog list @@ -14,6 +16,8 @@ catalog list catalog show ------------ +Display service catalog details + .. code:: bash os catalog show diff --git a/doc/source/command-objects/consumer.rst b/doc/source/command-objects/consumer.rst index 59ace845e0..91294fa20b 100644 --- a/doc/source/command-objects/consumer.rst +++ b/doc/source/command-objects/consumer.rst @@ -24,7 +24,7 @@ Create new consumer consumer delete --------------- -Delete a consumer +Delete consumer .. program:: consumer delete .. code:: bash diff --git a/doc/source/command-objects/container.rst b/doc/source/command-objects/container.rst index 3afaeb9217..845933d4cd 100644 --- a/doc/source/command-objects/container.rst +++ b/doc/source/command-objects/container.rst @@ -92,7 +92,7 @@ Save container contents locally container show -------------- -Show container details +Display container details .. program:: container show .. code:: bash diff --git a/doc/source/command-objects/domain.rst b/doc/source/command-objects/domain.rst index 66697ac3ea..94473570de 100644 --- a/doc/source/command-objects/domain.rst +++ b/doc/source/command-objects/domain.rst @@ -102,7 +102,7 @@ Set domain properties domain show ----------- -Show domain details +Display domain details .. program:: domain show .. code:: bash diff --git a/doc/source/command-objects/federation-protocol.rst b/doc/source/command-objects/federation-protocol.rst index 0ed0980a54..5b4ea48ace 100644 --- a/doc/source/command-objects/federation-protocol.rst +++ b/doc/source/command-objects/federation-protocol.rst @@ -34,7 +34,7 @@ Create new federation protocol federation protocol delete -------------------------- -Delete a federation protocol +Delete federation protocol .. program:: federation protocol delete .. code:: bash diff --git a/doc/source/command-objects/flavor.rst b/doc/source/command-objects/flavor.rst index 31b8e90227..0083da0dec 100644 --- a/doc/source/command-objects/flavor.rst +++ b/doc/source/command-objects/flavor.rst @@ -67,7 +67,7 @@ Create new flavor flavor delete ------------- -Delete a flavor +Delete flavor .. program:: flavor delete .. code:: bash diff --git a/doc/source/command-objects/identity-provider.rst b/doc/source/command-objects/identity-provider.rst index f08cde0188..47e274dd56 100644 --- a/doc/source/command-objects/identity-provider.rst +++ b/doc/source/command-objects/identity-provider.rst @@ -38,7 +38,7 @@ Create new identity provider identity provider delete ------------------------ -Delete an identity provider +Delete identity provider .. program:: identity provider delete .. code:: bash diff --git a/doc/source/command-objects/keypair.rst b/doc/source/command-objects/keypair.rst index 89d12a30ea..04c5721f91 100644 --- a/doc/source/command-objects/keypair.rst +++ b/doc/source/command-objects/keypair.rst @@ -30,7 +30,7 @@ Create new public key keypair delete -------------- -Delete a public key +Delete public key .. program keypair delete .. code:: bash @@ -55,7 +55,7 @@ List public key fingerprints keypair show ------------ -Show public key details +Display public key details .. program keypair show .. code:: bash @@ -70,4 +70,4 @@ Show public key details .. describe:: - Public key to show + Public key to display diff --git a/doc/source/command-objects/mapping.rst b/doc/source/command-objects/mapping.rst index 5c7535bd1c..25af474061 100644 --- a/doc/source/command-objects/mapping.rst +++ b/doc/source/command-objects/mapping.rst @@ -30,7 +30,7 @@ Create new mapping mapping delete -------------- -Delete a mapping +Delete mapping .. program:: mapping delete .. code:: bash diff --git a/doc/source/command-objects/object.rst b/doc/source/command-objects/object.rst index 5cbc95d71c..c45c10516f 100644 --- a/doc/source/command-objects/object.rst +++ b/doc/source/command-objects/object.rst @@ -122,7 +122,7 @@ Save object locally object show ----------- -Show object details +Display object details .. program:: object show .. code:: bash diff --git a/doc/source/command-objects/project.rst b/doc/source/command-objects/project.rst index 6b55b424bf..b39edb4d6a 100644 --- a/doc/source/command-objects/project.rst +++ b/doc/source/command-objects/project.rst @@ -149,6 +149,8 @@ Set project properties project show ------------ +Display project details + .. program:: project show .. code:: bash @@ -165,4 +167,4 @@ project show .. _project_show-project: .. describe:: - Project to show (name or ID) + Project to display (name or ID) diff --git a/doc/source/command-objects/region.rst b/doc/source/command-objects/region.rst index d1aedb3161..cb4a059eab 100644 --- a/doc/source/command-objects/region.rst +++ b/doc/source/command-objects/region.rst @@ -95,7 +95,7 @@ Set region properties .. _region_set-region-id: .. describe:: - Region ID to modify + Region to modify region show ----------- @@ -111,4 +111,4 @@ Display region details .. _region_show-region-id: .. describe:: - Region ID to display + Region to display diff --git a/doc/source/command-objects/role.rst b/doc/source/command-objects/role.rst index 19195eb554..57161b06be 100644 --- a/doc/source/command-objects/role.rst +++ b/doc/source/command-objects/role.rst @@ -142,7 +142,7 @@ Remove role from domain/project : user/group .. describe:: - Role to remove from ``:`` (name or ID) + Role to remove (name or ID) role set -------- @@ -169,6 +169,8 @@ Set role properties role show --------- +Display role details + .. program:: role show .. code:: bash @@ -177,4 +179,4 @@ role show .. describe:: - Role to show (name or ID) + Role to display (name or ID) diff --git a/doc/source/command-objects/user.rst b/doc/source/command-objects/user.rst index a9a98fe18f..9c81a40326 100644 --- a/doc/source/command-objects/user.rst +++ b/doc/source/command-objects/user.rst @@ -191,6 +191,8 @@ Set user properties user show --------- +Display user details + .. program:: user show .. code:: bash @@ -207,4 +209,4 @@ user show .. _user_show-user: .. describe:: - User to show (name or ID) + User to display (name or ID) diff --git a/openstackclient/compute/v2/aggregate.py b/openstackclient/compute/v2/aggregate.py index bfc2b115aa..84ed5c7d27 100644 --- a/openstackclient/compute/v2/aggregate.py +++ b/openstackclient/compute/v2/aggregate.py @@ -290,7 +290,7 @@ class SetAggregate(show.ShowOne): class ShowAggregate(show.ShowOne): - """Show a specific aggregate""" + """Display aggregate details""" log = logging.getLogger(__name__ + '.ShowAggregate') @@ -299,7 +299,7 @@ class ShowAggregate(show.ShowOne): parser.add_argument( 'aggregate', metavar='', - help='Aggregate to show (name or ID)', + help='Aggregate to display (name or ID)', ) return parser diff --git a/openstackclient/compute/v2/flavor.py b/openstackclient/compute/v2/flavor.py index 6f3788a029..bb89a85b5e 100644 --- a/openstackclient/compute/v2/flavor.py +++ b/openstackclient/compute/v2/flavor.py @@ -125,7 +125,7 @@ class CreateFlavor(show.ShowOne): class DeleteFlavor(command.Command): - """Delete a flavor""" + """Delete flavor""" log = logging.getLogger(__name__ + ".DeleteFlavor") diff --git a/openstackclient/compute/v2/keypair.py b/openstackclient/compute/v2/keypair.py index 6a158d86ff..edf25f8358 100644 --- a/openstackclient/compute/v2/keypair.py +++ b/openstackclient/compute/v2/keypair.py @@ -80,7 +80,7 @@ class CreateKeypair(show.ShowOne): class DeleteKeypair(command.Command): - """Delete a public key""" + """Delete public key""" log = logging.getLogger(__name__ + '.DeleteKeypair') @@ -121,7 +121,7 @@ class ListKeypair(lister.Lister): class ShowKeypair(show.ShowOne): - """Show public key details""" + """Display public key details""" log = logging.getLogger(__name__ + '.ShowKeypair') @@ -130,7 +130,7 @@ class ShowKeypair(show.ShowOne): parser.add_argument( 'name', metavar='', - help='Public key to show', + help='Public key to display', ) parser.add_argument( '--public-key', diff --git a/openstackclient/identity/v2_0/catalog.py b/openstackclient/identity/v2_0/catalog.py index 1a96fdf60f..330dcf3b13 100644 --- a/openstackclient/identity/v2_0/catalog.py +++ b/openstackclient/identity/v2_0/catalog.py @@ -59,7 +59,7 @@ class ListCatalog(lister.Lister): class ShowCatalog(show.ShowOne): - """Show service catalog details""" + """Display service catalog details""" log = logging.getLogger(__name__ + '.ShowCatalog') diff --git a/openstackclient/identity/v2_0/project.py b/openstackclient/identity/v2_0/project.py index 9b195600fc..d01807a600 100644 --- a/openstackclient/identity/v2_0/project.py +++ b/openstackclient/identity/v2_0/project.py @@ -241,7 +241,7 @@ class SetProject(command.Command): class ShowProject(show.ShowOne): - """Show project details""" + """Display project details""" log = logging.getLogger(__name__ + '.ShowProject') @@ -250,7 +250,7 @@ class ShowProject(show.ShowOne): parser.add_argument( 'project', metavar='', - help=_('Project to show (name or ID)')) + help=_('Project to display (name or ID)')) return parser def take_action(self, parsed_args): diff --git a/openstackclient/identity/v2_0/role.py b/openstackclient/identity/v2_0/role.py index d03664e07b..f5f901ee81 100644 --- a/openstackclient/identity/v2_0/role.py +++ b/openstackclient/identity/v2_0/role.py @@ -226,7 +226,7 @@ class ListUserRole(lister.Lister): class RemoveRole(command.Command): - """Remove role from project:user""" + """Remove role from project : user""" log = logging.getLogger(__name__ + '.RemoveRole') @@ -235,7 +235,7 @@ class RemoveRole(command.Command): parser.add_argument( 'role', metavar='', - help=_('Role to remove from : (name or ID)'), + help=_('Role to remove (name or ID)'), ) parser.add_argument( '--project', @@ -267,7 +267,7 @@ class RemoveRole(command.Command): class ShowRole(show.ShowOne): - """Show single role""" + """Display role details""" log = logging.getLogger(__name__ + '.ShowRole') @@ -276,7 +276,7 @@ class ShowRole(show.ShowOne): parser.add_argument( 'role', metavar='', - help=_('Role to show (name or ID)'), + help=_('Role to display (name or ID)'), ) return parser diff --git a/openstackclient/identity/v2_0/service.py b/openstackclient/identity/v2_0/service.py index 0b98a90360..82d4fd7201 100644 --- a/openstackclient/identity/v2_0/service.py +++ b/openstackclient/identity/v2_0/service.py @@ -144,7 +144,7 @@ class ListService(lister.Lister): class ShowService(show.ShowOne): - """Show service details""" + """Display service details""" log = logging.getLogger(__name__ + '.ShowService') diff --git a/openstackclient/identity/v2_0/user.py b/openstackclient/identity/v2_0/user.py index b5bbce3bd3..500aeec32e 100644 --- a/openstackclient/identity/v2_0/user.py +++ b/openstackclient/identity/v2_0/user.py @@ -349,7 +349,7 @@ class SetUser(command.Command): class ShowUser(show.ShowOne): - """Show user details""" + """Display user details""" log = logging.getLogger(__name__ + '.ShowUser') diff --git a/openstackclient/identity/v3/consumer.py b/openstackclient/identity/v3/consumer.py index c5e263926c..ffbd5104cf 100644 --- a/openstackclient/identity/v3/consumer.py +++ b/openstackclient/identity/v3/consumer.py @@ -51,7 +51,7 @@ class CreateConsumer(show.ShowOne): class DeleteConsumer(command.Command): - """Delete a consumer""" + """Delete consumer""" log = logging.getLogger(__name__ + '.DeleteConsumer') diff --git a/openstackclient/identity/v3/domain.py b/openstackclient/identity/v3/domain.py index 189f097052..38f99a9772 100644 --- a/openstackclient/identity/v3/domain.py +++ b/openstackclient/identity/v3/domain.py @@ -187,7 +187,7 @@ class SetDomain(command.Command): class ShowDomain(show.ShowOne): - """Show domain details""" + """Display domain details""" log = logging.getLogger(__name__ + '.ShowDomain') diff --git a/openstackclient/identity/v3/federation_protocol.py b/openstackclient/identity/v3/federation_protocol.py index 5a651165b1..57e8255e9c 100644 --- a/openstackclient/identity/v3/federation_protocol.py +++ b/openstackclient/identity/v3/federation_protocol.py @@ -69,7 +69,7 @@ class CreateProtocol(show.ShowOne): class DeleteProtocol(command.Command): - """Delete a federation protocol""" + """Delete federation protocol""" log = logging.getLogger(__name__ + '.DeleteProtocol') diff --git a/openstackclient/identity/v3/identity_provider.py b/openstackclient/identity/v3/identity_provider.py index f46341a16b..691446da4d 100644 --- a/openstackclient/identity/v3/identity_provider.py +++ b/openstackclient/identity/v3/identity_provider.py @@ -69,7 +69,7 @@ class CreateIdentityProvider(show.ShowOne): class DeleteIdentityProvider(command.Command): - """Delete an identity provider""" + """Delete identity provider""" log = logging.getLogger(__name__ + '.DeleteIdentityProvider') diff --git a/openstackclient/identity/v3/mapping.py b/openstackclient/identity/v3/mapping.py index a1f60438f6..c79331ec7d 100644 --- a/openstackclient/identity/v3/mapping.py +++ b/openstackclient/identity/v3/mapping.py @@ -112,7 +112,7 @@ class CreateMapping(show.ShowOne, _RulesReader): class DeleteMapping(command.Command): - """Delete a mapping""" + """Delete mapping""" log = logging.getLogger(__name__ + '.DeleteMapping') diff --git a/openstackclient/identity/v3/project.py b/openstackclient/identity/v3/project.py index 28eb427716..9a54e5cd08 100644 --- a/openstackclient/identity/v3/project.py +++ b/openstackclient/identity/v3/project.py @@ -298,7 +298,7 @@ class SetProject(command.Command): class ShowProject(show.ShowOne): - """Show project command""" + """Display project details""" log = logging.getLogger(__name__ + '.ShowProject') @@ -307,7 +307,7 @@ class ShowProject(show.ShowOne): parser.add_argument( 'project', metavar='', - help='Name or ID of project to display', + help='Project to display (name or ID)', ) parser.add_argument( '--domain', diff --git a/openstackclient/identity/v3/region.py b/openstackclient/identity/v3/region.py index 5fb7391362..5cb51fc5ec 100644 --- a/openstackclient/identity/v3/region.py +++ b/openstackclient/identity/v3/region.py @@ -138,7 +138,7 @@ class SetRegion(command.Command): parser.add_argument( 'region', metavar='', - help=_('Region ID to modify'), + help=_('Region to modify'), ) parser.add_argument( '--parent-region', @@ -188,7 +188,7 @@ class ShowRegion(show.ShowOne): parser.add_argument( 'region', metavar='', - help=_('Region ID to display'), + help=_('Region to display'), ) return parser diff --git a/openstackclient/identity/v3/role.py b/openstackclient/identity/v3/role.py index d680278eea..0376070907 100644 --- a/openstackclient/identity/v3/role.py +++ b/openstackclient/identity/v3/role.py @@ -467,7 +467,7 @@ class SetRole(command.Command): class ShowRole(show.ShowOne): - """Show single role""" + """Display role details""" log = logging.getLogger(__name__ + '.ShowRole') @@ -476,7 +476,7 @@ class ShowRole(show.ShowOne): parser.add_argument( 'role', metavar='', - help='Role to show (name or ID)', + help='Role to display (name or ID)', ) return parser diff --git a/openstackclient/identity/v3/service.py b/openstackclient/identity/v3/service.py index f4c5d42629..c6dfa8d089 100644 --- a/openstackclient/identity/v3/service.py +++ b/openstackclient/identity/v3/service.py @@ -194,7 +194,7 @@ class SetService(command.Command): class ShowService(show.ShowOne): - """Show service details""" + """Display service details""" log = logging.getLogger(__name__ + '.ShowService') diff --git a/openstackclient/identity/v3/user.py b/openstackclient/identity/v3/user.py index 4fb7b6d1e0..7b847eedb8 100644 --- a/openstackclient/identity/v3/user.py +++ b/openstackclient/identity/v3/user.py @@ -422,7 +422,7 @@ class SetPasswordUser(command.Command): class ShowUser(show.ShowOne): - """Show user details""" + """Display user details""" log = logging.getLogger(__name__ + '.ShowUser') diff --git a/openstackclient/object/v1/container.py b/openstackclient/object/v1/container.py index b75888e408..bc4fdec81b 100644 --- a/openstackclient/object/v1/container.py +++ b/openstackclient/object/v1/container.py @@ -179,7 +179,7 @@ class SaveContainer(command.Command): class ShowContainer(show.ShowOne): - """Show container details""" + """Display container details""" log = logging.getLogger(__name__ + '.ShowContainer') diff --git a/openstackclient/object/v1/object.py b/openstackclient/object/v1/object.py index 781dd047fa..752d78423e 100644 --- a/openstackclient/object/v1/object.py +++ b/openstackclient/object/v1/object.py @@ -222,7 +222,7 @@ class SaveObject(command.Command): class ShowObject(show.ShowOne): - """Show object details""" + """Display object details""" log = logging.getLogger(__name__ + '.ShowObject')