cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

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

Browse source
This commit is contained in:
Michael DeHaan 2013-05-11 16:29:41 -04:00
parent 0748e86f0e
commit 9ca0289dee
2 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
examples/DOCUMENTATION.yaml
View file

@ -26,4 +26,4 @@ options:
default: a string or the word null default: a string or the word null
choices: [list, of, choices] choices: [list, of, choices]
aliases: [list, of, aliases] aliases: [list, of, aliases]
version_added: 0.X version_added: 1.X

11
hacking/module_formatter.py
View file

@ -136,7 +136,10 @@ def return_data(text, options, outputname, module):
def boilerplate(): def boilerplate():
if not os.path.exists(EXAMPLE_YAML): if not os.path.exists(EXAMPLE_YAML):
print >>sys.stderr, "Missing example boiler plate: %S" % EXAMPLE_YAML print >>sys.stderr, "Missing example boiler plate: %S" % EXAMPLE_YAML
print "DOCUMENTATION = '''"
print file(EXAMPLE_YAML).read() print file(EXAMPLE_YAML).read()
print "'''"
print ""
def list_modules(module_dir): def list_modules(module_dir):
categories = {} categories = {}
@ -217,6 +220,14 @@ def main():
if options.do_boilerplate: if options.do_boilerplate:
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) sys.exit(0)
if not options.module_dir: if not options.module_dir: