ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-24 11:21:25 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

ansible-doc now shows return value docs

Browse source
This commit is contained in:
Brian Coca 2015-02-12 23:20:43 -05:00
parent 8be8a7e2f5
commit 1e818f9c50
2 changed files with 11 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

6
lib/ansible/utils/module_docs.py
View file

@ -44,6 +44,7 @@ def get_docstring(filename, verbose=False):
doc = None
plainexamples = None
returndocs = None
try:
# Thank you, Habbie, for this bit of code :-)
@ -89,10 +90,13 @@ def get_docstring(filename, verbose=False):
if 'EXAMPLES' in (t.id for t in child.targets):
plainexamples = child.value.s[1:] # Skip first empty line
if 'RETURN' in (t.id for t in child.targets):
returndocs = child.value.s[1:]
except:
traceback.print_exc() # temp
if verbose == True:
traceback.print_exc()
print "unable to parse %s" % filename
return doc, plainexamples
return doc, plainexamples, returndocs