* add necessary dots to returns descriptions
(cherry picked from commit bfba0ffc45
)
This commit is contained in:
parent
3fadb5eb28
commit
7caa7e1162
1 changed files with 5 additions and 3 deletions
|
@ -331,13 +331,15 @@ Per playbook best practices, each example should include a ``name:`` line::
|
||||||
|
|
||||||
EXAMPLES = r'''
|
EXAMPLES = r'''
|
||||||
- name: Ensure foo is installed
|
- name: Ensure foo is installed
|
||||||
modulename:
|
namespace.collection.modulename:
|
||||||
name: foo
|
name: foo
|
||||||
state: present
|
state: present
|
||||||
'''
|
'''
|
||||||
|
|
||||||
The ``name:`` line should be capitalized and not include a trailing dot.
|
The ``name:`` line should be capitalized and not include a trailing dot.
|
||||||
|
|
||||||
|
Use a fully qualified collection name (FQCN) as a part of the module's name like in the example above. For modules in ``ansible-base``, use the ``ansible.builtin.`` identifier, for example ``ansible.builtin.debug``.
|
||||||
|
|
||||||
If your examples use boolean options, use yes/no values. Since the documentation generates boolean values as yes/no, having the examples use these values as well makes the module documentation more consistent.
|
If your examples use boolean options, use yes/no values. Since the documentation generates boolean values as yes/no, having the examples use these values as well makes the module documentation more consistent.
|
||||||
|
|
||||||
If your module returns facts that are often needed, an example of how to use them can be helpful.
|
If your module returns facts that are often needed, an example of how to use them can be helpful.
|
||||||
|
@ -393,12 +395,12 @@ Here are two example ``RETURN`` sections, one with three simple fields and one w
|
||||||
|
|
||||||
RETURN = r'''
|
RETURN = r'''
|
||||||
packages:
|
packages:
|
||||||
description: Information about package requirements
|
description: Information about package requirements.
|
||||||
returned: success
|
returned: success
|
||||||
type: complex
|
type: complex
|
||||||
contains:
|
contains:
|
||||||
missing:
|
missing:
|
||||||
description: Packages that are missing from the system
|
description: Packages that are missing from the system.
|
||||||
returned: success
|
returned: success
|
||||||
type: list
|
type: list
|
||||||
sample:
|
sample:
|
||||||
|
|
Loading…
Reference in a new issue