From 0748e86f0ef69adaeea6556816d0c547128c582a Mon Sep 17 00:00:00 2001 From: Michael DeHaan Date: Sat, 11 May 2013 16:27:22 -0400 Subject: [PATCH] Fix documentation about examples in modules so folks use the new style. --- docsite/latest/rst/moduledev.rst | 11 +++-------- examples/DOCUMENTATION.yaml | 4 ---- 2 files changed, 3 insertions(+), 12 deletions(-) diff --git a/docsite/latest/rst/moduledev.rst b/docsite/latest/rst/moduledev.rst index 723ddba0b2e..416a2df354b 100644 --- a/docsite/latest/rst/moduledev.rst +++ b/docsite/latest/rst/moduledev.rst @@ -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:: diff --git a/examples/DOCUMENTATION.yaml b/examples/DOCUMENTATION.yaml index 7365c7bd9fe..f5c285932a6 100644 --- a/examples/DOCUMENTATION.yaml +++ b/examples/DOCUMENTATION.yaml @@ -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