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

clarify returned value of RETURN nlock (#65724)

Browse source
This commit is contained in:
Evgeni Golov 2019-12-13 00:12:38 +01:00 committed by Alicia Cozine
parent 1f0b5b09cd
commit 057e137998
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/docsite/rst/dev_guide/developing_modules_documenting.rst
View file

@ -384,7 +384,7 @@ Otherwise, for each value returned, provide the following fields. All fields are
:description:
Detailed description of what this value represents. Capitalized and with trailing dot.
:returned:
When this value is returned, such as ``always``, or ``on success``.
When this value is returned, such as ``always``, ``changed`` or ``success``. This is a string and can contain any human-readable content.
:type:
Data type.
:elements:
@ -420,7 +420,7 @@ Here are two example ``RETURN`` sections, one with three simple fields and one w
RETURN = r'''
packages:
description: Information about package requirements
returned: On success
returned: success
type: complex
contains:
missing: