ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-10-21 19:43:59 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

DOCUMENTATION strings

Browse source
This commit is contained in:
Jan-Piet Mens 2012-11-21 18:49:30 +01:00
commit caf003c813
38 changed files with 111 additions and 102 deletions
Download patch file Download diff file Expand all files Collapse all files

7
docsite/rst/moduledev.rst
View file

@ -347,6 +347,13 @@ Include it in your module file like this::
description: Optional words describing this example
'''
The ``description``, ``notes`` and ``description`` within ``examples``
support formatting in some of the output formats (e.g. ``rst``, ``man``).
These formatting functions are ``U()``, ``M()``, ``I()``, and ``C()``
for URL, module, italic, and constant-width respectively. It is suggested
to use ``C()`` for file and option names, and ``I()`` when referencing
parameters; module names should be specifies as ``M(module)``.
Building & Testing
++++++++++++++++++