Fix python-openstackclient plugin doc build

A help string in a plugin command argument help string contained (a typo
and) some invalid sphinx-isms causing autoprogram-cliff building from
python-openstackclient to fail with:

.../python-openstackclient/doc/source/cli/plugin-commands/watcher.rst:30:Inline emphasis start-string without end-string.
and
<CreateAuditTemplate>:1:Unexpected indentation.

This commit fixes the (typo and) help string formatting.

Change-Id: Ifb668b9ada94b679672f3bab562410bf12f4ca64
This commit is contained in:
Eric Fried 2019-10-22 13:33:26 -05:00 committed by chenker
parent 1d1f28a256
commit 0c7e306642
2 changed files with 46 additions and 45 deletions

@ -182,7 +182,7 @@ class CreateAudit(command.ShowOne):
dest='interval', dest='interval',
metavar='<interval>', metavar='<interval>',
help=_('Audit interval (in seconds or cron format). ' help=_('Audit interval (in seconds or cron format). '
'Cron inteval can be used like: "*/5 * * * *". ' 'Cron interval can be used like: ``*/5 * * * *``. '
'Only used if the audit is CONTINUOUS.')) 'Only used if the audit is CONTINUOUS.'))
parser.add_argument( parser.add_argument(
'-g', '--goal', '-g', '--goal',

@ -167,8 +167,8 @@ class CreateAuditTemplate(command.ShowOne):
metavar='<path>', metavar='<path>',
help=_("Part of the cluster on which an audit will be done.\n" help=_("Part of the cluster on which an audit will be done.\n"
"Can be provided either in yaml or json file.\n" "Can be provided either in yaml or json file.\n"
"YAML example:\n" "YAML example::\n"
"---\n" "\n"
" - compute:\n" " - compute:\n"
" - host_aggregates:\n" " - host_aggregates:\n"
" - id: 1\n" " - id: 1\n"
@ -201,8 +201,9 @@ class CreateAuditTemplate(command.ShowOne):
" - uuid: UUID1\n" " - uuid: UUID1\n"
" - uuid: UUID2\n" " - uuid: UUID2\n"
"\n" "\n"
"JSON example:\n" "JSON example::\n"
"[\n" "\n"
" [\n"
" {\"compute\":\n" " {\"compute\":\n"
" [{\"host_aggregates\": [\n" " [{\"host_aggregates\": [\n"
" {\"id\": 1},\n" " {\"id\": 1},\n"