slightly better presentation docs

- description items are now separated
- choices/defaults start at their own line
pull/17091/head
Brian Coca 8 years ago
parent b3c686f4c5
commit 64a8d24b72

@ -275,17 +275,16 @@ class DocCLI(CLI):
text.append("%s %s" % (opt_leadin, o)) text.append("%s %s" % (opt_leadin, o))
if isinstance(opt['description'], list): if isinstance(opt['description'], list):
desc = " ".join(opt['description']) for entry in opt['description']:
text.append(textwrap.fill(CLI.tty_ify(entry), limit, initial_indent=opt_indent, subsequent_indent=opt_indent))
else: else:
desc = opt['description'] text.append(textwrap.fill(CLI.tty_ify(opt['description']), limit, initial_indent=opt_indent, subsequent_indent=opt_indent))
if 'choices' in opt: if 'choices' in opt:
choices = ", ".join(str(i) for i in opt['choices']) choices = "(Choices: " + ", ".join(str(i) for i in opt['choices']) + ")"
desc = desc + " (Choices: " + choices + ")"
if 'default' in opt or not required: if 'default' in opt or not required:
default = str(opt.get('default', '(null)')) default = "[Default: " + str(opt.get('default', '(null)')) + "]"
desc = desc + " [Default: " + default + "]" text.append(textwrap.fill(CLI.tty_ify(choices + default), limit, initial_indent=opt_indent, subsequent_indent=opt_indent))
text.append("%s\n" % textwrap.fill(CLI.tty_ify(desc), limit, initial_indent=opt_indent, subsequent_indent=opt_indent))
if 'notes' in doc and doc['notes'] and len(doc['notes']) > 0: if 'notes' in doc and doc['notes'] and len(doc['notes']) > 0:
notes = " ".join(doc['notes']) notes = " ".join(doc['notes'])

Loading…
Cancel
Save