ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Add spaces between sentences in formatted docs.

Browse source 
Increases readability when using `ansible-doc`.
This commit is contained in:
C. Morgan Hamill 2014-05-20 15:41:22 -04:00
parent 03efbfca29
commit 43b72f2a80
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
bin/ansible-doc
View file

@ -91,7 +91,7 @@ def get_man_text(doc):
text = []
text.append("> %s\n" % doc['module'].upper())
desc = "".join(doc['description'])
desc = " ".join(doc['description'])
text.append("%s\n" % textwrap.fill(tty_ify(desc), initial_indent=" ", subsequent_indent=" "))
@ -108,7 +108,7 @@ def get_man_text(doc):
text.append("%s %s" % (opt_leadin, o))
desc = "".join(opt['description'])
desc = " ".join(opt['description'])
if 'choices' in opt:
choices = ", ".join(str(i) for i in opt['choices'])
@ -117,7 +117,7 @@ def get_man_text(doc):
subsequent_indent=opt_indent))
if 'notes' in doc and len(doc['notes']) > 0:
notes = "".join(doc['notes'])
notes = " ".join(doc['notes'])
text.append("Notes:%s\n" % textwrap.fill(tty_ify(notes), initial_indent=" ",
subsequent_indent=opt_indent))
@ -142,13 +142,13 @@ def get_man_text(doc):
def get_snippet_text(doc):
text = []
desc = tty_ify("".join(doc['short_description']))
desc = tty_ify(" ".join(doc['short_description']))
text.append("- name: %s" % (desc))
text.append(" action: %s" % (doc['module']))
for o in sorted(doc['options'].keys()):
opt = doc['options'][o]
desc = tty_ify("".join(opt['description']))
desc = tty_ify(" ".join(opt['description']))
if opt.get('required', False):
s = o + "="