summaryrefslogtreecommitdiff
path: root/bin/ansible-doc
diff options
context:
space:
mode:
authorC. Morgan Hamill <chamill@wesleyan.edu>2014-05-20 15:41:22 -0400
committerC. Morgan Hamill <chamill@wesleyan.edu>2014-07-17 09:10:42 -0400
commit43b72f2a805a67601278a4466614a52c1e89de83 (patch)
treea8d5f2d2fffc912e28230326e87a0931f9b158fb /bin/ansible-doc
parent03efbfca2992b9e91b607f766dfb3e2f7a89e8fe (diff)
downloadansible-43b72f2a805a67601278a4466614a52c1e89de83.tar.gz
Add spaces between sentences in formatted docs.
Increases readability when using `ansible-doc`.
Diffstat (limited to 'bin/ansible-doc')
-rwxr-xr-xbin/ansible-doc10
1 files changed, 5 insertions, 5 deletions
diff --git a/bin/ansible-doc b/bin/ansible-doc
index a77fff8130..2b1b796ed9 100755
--- a/bin/ansible-doc
+++ b/bin/ansible-doc
@@ -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 + "="