mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-06 13:22:48 +00:00
Merge pull request #10295 from bcoca/show_return_val_docs
ansible-doc now shows return value docs
This commit is contained in:
@@ -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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user