Fix documentation about examples in modules so folks use the new style.

This commit is contained in:
Michael DeHaan 2013-05-11 16:27:22 -04:00
parent cdda88fda7
commit 0748e86f0e
2 changed files with 3 additions and 12 deletions

View file

@ -353,15 +353,10 @@ syntax highlighting before you include it in your Python file.
Example
+++++++
Here's a correctly formatted YAML document we could use for a
``DOCUMENTATION`` string:
To print a basic documentation string, run ``./hacking/module_formatter.py -G``.
.. literalinclude:: ../../examples/DOCUMENTATION.yaml
This is available in the 'examples/' directory of the of the Ansible
github repository, and you can have that generated with
``./hacking/module_formatter.py -G``. You can copy it into your module and use
it as a starting point when writing your own docs.
You can copy it into your module and use it as a starting point
when writing your own docs.
Include it in your module file like this::

View file

@ -27,7 +27,3 @@ options:
choices: [list, of, choices]
aliases: [list, of, aliases]
version_added: 0.X
examples:
# One or more of the following:
- code: modulename opt1=arg1 opt2=arg2
description: Optional words describing this example