From 04d30c1855f1229d986c7ad3bdae43a2b2d38990 Mon Sep 17 00:00:00 2001 From: Dean Troyer Date: Tue, 18 Nov 2014 15:11:32 -0600 Subject: Command object docs: project, role, user project role user user role Change-Id: I445e09a3ffb69114912ae562a9285963a636bfd1 --- openstackclient/identity/v2_0/project.py | 22 +++++++++--------- openstackclient/identity/v2_0/role.py | 37 ++++++++++++++++++----------- openstackclient/identity/v2_0/user.py | 40 ++++++++++++++++---------------- 3 files changed, 55 insertions(+), 44 deletions(-) (limited to 'openstackclient/identity/v2_0') diff --git a/openstackclient/identity/v2_0/project.py b/openstackclient/identity/v2_0/project.py index 2d66b400..df759ce6 100644 --- a/openstackclient/identity/v2_0/project.py +++ b/openstackclient/identity/v2_0/project.py @@ -42,8 +42,8 @@ class CreateProject(show.ShowOne): ) parser.add_argument( '--description', - metavar='', - help=_('New project description'), + metavar='', + help=_('Project description'), ) enable_group = parser.add_mutually_exclusive_group() enable_group.add_argument( @@ -60,7 +60,7 @@ class CreateProject(show.ShowOne): '--property', metavar='', action=parseractions.KeyValueAction, - help=_('Property to add for this project ' + help=_('Add a property to ' '(repeat option to set multiple properties)'), ) parser.add_argument( @@ -104,7 +104,7 @@ class CreateProject(show.ShowOne): class DeleteProject(command.Command): - """Delete project""" + """Delete an existing project""" log = logging.getLogger(__name__ + '.DeleteProject') @@ -169,17 +169,17 @@ class SetProject(command.Command): parser.add_argument( 'project', metavar='', - help=_('Project to change (name or ID)'), + help=_('Project to modify (name or ID)'), ) parser.add_argument( '--name', - metavar='', - help=_('New project name'), + metavar='', + help=_('Set project name'), ) parser.add_argument( '--description', - metavar='', - help=_('New project description'), + metavar='', + help=_('Set project description'), ) enable_group = parser.add_mutually_exclusive_group() enable_group.add_argument( @@ -196,7 +196,7 @@ class SetProject(command.Command): '--property', metavar='', action=parseractions.KeyValueAction, - help=_('Property to add for this project ' + help=_('Set a project property ' '(repeat option to set multiple properties)'), ) return parser @@ -249,7 +249,7 @@ class ShowProject(show.ShowOne): parser.add_argument( 'project', metavar='', - help=_('Project to display (name or ID)')) + help=_('Project to show (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 df69e857..cec95095 100644 --- a/openstackclient/identity/v2_0/role.py +++ b/openstackclient/identity/v2_0/role.py @@ -38,17 +38,20 @@ class AddRole(show.ShowOne): parser.add_argument( 'role', metavar='', - help=_('Role name or ID to add to user')) + help=_('Role to add to : (name or ID)'), + ) parser.add_argument( '--project', metavar='', required=True, - help=_('Include project (name or ID)')) + help=_('Include (name or ID)'), + ) parser.add_argument( '--user', metavar='', required=True, - help=_('Name or ID of user to include')) + help=_('Include (name or ID)'), + ) return parser def take_action(self, parsed_args): @@ -80,8 +83,9 @@ class CreateRole(show.ShowOne): parser = super(CreateRole, self).get_parser(prog_name) parser.add_argument( 'role_name', - metavar='', - help=_('New role name')) + metavar='', + help=_('New role name'), + ) parser.add_argument( '--or-show', action='store_true', @@ -110,7 +114,7 @@ class CreateRole(show.ShowOne): class DeleteRole(command.Command): - """Delete existing role""" + """Delete an existing role""" log = logging.getLogger(__name__ + '.DeleteRole') @@ -119,7 +123,8 @@ class DeleteRole(command.Command): parser.add_argument( 'role', metavar='', - help=_('Name or ID of role to delete')) + help=_('Role to delete (name or ID)'), + ) return parser def take_action(self, parsed_args): @@ -162,11 +167,13 @@ class ListUserRole(lister.Lister): 'user', metavar='', nargs='?', - help=_('Name or ID of user to include')) + help=_('User to list (name or ID)'), + ) parser.add_argument( '--project', metavar='', - help=_('Include project (name or ID)')) + help=_('Filter users by (name or ID)'), + ) return parser def take_action(self, parsed_args): @@ -227,17 +234,20 @@ class RemoveRole(command.Command): parser.add_argument( 'role', metavar='', - help=_('Role name or ID to remove from user')) + help=_('Role to remove from : (name or ID)'), + ) parser.add_argument( '--project', metavar='', required=True, - help=_('Project to include (name or ID)')) + help=_('Include (name or ID)'), + ) parser.add_argument( '--user', metavar='', required=True, - help=_('Name or ID of user')) + help=_('Include (name or ID)'), + ) return parser def take_action(self, parsed_args): @@ -265,7 +275,8 @@ class ShowRole(show.ShowOne): parser.add_argument( 'role', metavar='', - help=_('Name or ID of role to display')) + help=_('Role to show (name or ID)'), + ) return parser def take_action(self, parsed_args): diff --git a/openstackclient/identity/v2_0/user.py b/openstackclient/identity/v2_0/user.py index 2ebcba18..955e19e7 100644 --- a/openstackclient/identity/v2_0/user.py +++ b/openstackclient/identity/v2_0/user.py @@ -36,13 +36,18 @@ class CreateUser(show.ShowOne): parser = super(CreateUser, self).get_parser(prog_name) parser.add_argument( 'name', - metavar='', + metavar='', help=_('New user name'), ) + parser.add_argument( + '--project', + metavar='', + help=_('Default project (name or ID)'), + ) parser.add_argument( '--password', - metavar='', - help=_('New user password'), + metavar='', + help=_('Set user password'), ) parser.add_argument( '--password-prompt', @@ -52,13 +57,8 @@ class CreateUser(show.ShowOne): ) parser.add_argument( '--email', - metavar='', - help=_('New user email address'), - ) - parser.add_argument( - '--project', - metavar='', - help=_('Set default project (name or ID)'), + metavar='', + help=_('Set user email address'), ) enable_group = parser.add_mutually_exclusive_group() enable_group.add_argument( @@ -258,13 +258,18 @@ class SetUser(command.Command): ) parser.add_argument( '--name', - metavar='', - help=_('New user name'), + metavar='', + help=_('Set user name'), + ) + parser.add_argument( + '--project', + metavar='', + help=_('Set default project (name or ID)'), ) parser.add_argument( '--password', metavar='', - help=_('New user password'), + help=_('Set user password'), ) parser.add_argument( '--password-prompt', @@ -274,13 +279,8 @@ class SetUser(command.Command): ) parser.add_argument( '--email', - metavar='', - help=_('New user email address'), - ) - parser.add_argument( - '--project', - metavar='', - help=_('New default project (name or ID)'), + metavar='', + help=_('Set user email address'), ) enable_group = parser.add_mutually_exclusive_group() enable_group.add_argument( -- cgit v1.2.1