From 0659df1e97f6b4bca5e2d7baa5bda9666f6cd60b Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Wed, 19 Feb 2014 20:58:44 +0100 Subject: [PATCH] Improve help strings Follow oslo.config style guide for help strings better to create consistent help strings: * Finish help strings with "." * Fix capitalization in one example * Fix wording (use "by a semicolon") Change-Id: I402401509481ce18bac333cd6d96554d64725b57 --- heatclient/v1/shell.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/heatclient/v1/shell.py b/heatclient/v1/shell.py index 741f0216..636ba5fc 100644 --- a/heatclient/v1/shell.py +++ b/heatclient/v1/shell.py @@ -39,7 +39,7 @@ import heatclient.exc as exc @utils.arg('-P', '--parameters', metavar='', help='Parameter values used to create the stack. ' 'This can be specified multiple times, or once with parameters ' - 'separated by semicolon.', + 'separated by a semicolon.', action='append') @utils.arg('name', metavar='', help='Name of the stack to create.') @@ -64,7 +64,7 @@ def do_create(hc, args): @utils.arg('-P', '--parameters', metavar='', help='Parameter values used to create the stack. ' 'This can be specified multiple times, or once with parameters ' - 'separated by semicolon.', + 'separated by a semicolon.', action='append') @utils.arg('name', metavar='', help='Name of the stack to create.') @@ -99,18 +99,18 @@ def do_stack_create(hc, args): @utils.arg('-u', '--template-url', metavar='', help='URL of template.') @utils.arg('-o', '--template-object', metavar='', - help='URL to retrieve template object (e.g from swift)') + help='URL to retrieve template object (e.g from swift).') @utils.arg('-c', '--create-timeout', metavar='', default=60, type=int, - help='Stack creation timeout in minutes. Default: 60') + help='Stack creation timeout in minutes. Default: 60.') @utils.arg('-a', '--adopt-file', metavar='', help='Path to adopt stack data file.') @utils.arg('-r', '--enable-rollback', default=False, action="store_true", - help='Enable rollback on create/update failure') + help='Enable rollback on create/update failure.') @utils.arg('-P', '--parameters', metavar='', help='Parameter values used to create the stack. ' 'This can be specified multiple times, or once with parameters ' - 'separated by semicolon.', + 'separated by a semicolon.', action='append') @utils.arg('name', metavar='', help='Name of the stack to adopt.') @@ -331,7 +331,7 @@ def do_resource_type_list(hc, args={}): @utils.arg('resource_type', metavar='', - help='Resource Type to get the details for.') + help='Resource type to get the details for.') def do_resource_type_show(hc, args={}): '''Show the resource type.''' try: