Commit 9ca0289d by Michael DeHaan

Fixup the module formatter to explain the EXAMPLES string as well.

parent 0748e86f
......@@ -26,4 +26,4 @@ options:
default: a string or the word null
choices: [list, of, choices]
aliases: [list, of, aliases]
version_added: 0.X
version_added: 1.X
......@@ -136,7 +136,10 @@ def return_data(text, options, outputname, module):
def boilerplate():
if not os.path.exists(EXAMPLE_YAML):
print >>sys.stderr, "Missing example boiler plate: %S" % EXAMPLE_YAML
print "DOCUMENTATION = '''"
print file(EXAMPLE_YAML).read()
print "'''"
print ""
def list_modules(module_dir):
categories = {}
......@@ -217,6 +220,14 @@ def main():
if options.do_boilerplate:
boilerplate()
print ""
print "EXAMPLES = '''"
print "# example of doing ___ from a playbook"
print "your_module: some_arg=1 other_arg=2"
print "'''"
print ""
sys.exit(0)
if not options.module_dir:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment