internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-04-18 06:41:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

RETURNS can include version_added (#25810)

Browse Source
This commit is contained in:
John R Barker
2017-06-16 20:17:38 +01:00
committed by GitHub
parent 9c849d5c94
commit 5551e87755
2 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/docsite/rst/dev_guide/developing_modules_documenting.rst
View File

@@ -235,6 +235,9 @@ The following fields can be used and are all required unless specified otherwise
Data type
:sample:
One or more examples.
:version_added:
Only needed if this return was extended after initial Ansible release, i.e. this is greater than the top level `version_added` field.
This is a string, and not a float, i.e. ``version_added: "2.3"``.
:contains:
Optional, if you set `type: complex` you can detail the dictionary here by repeating the above elements.
@@ -249,6 +252,9 @@ The following fields can be used and are all required unless specified otherwise
Data type
:sample:
One or more examples.
:version_added:
Only needed if this return was extended after initial Ansible release, i.e. this is greater than the top level `version_added` field.
This is a string, and not a float, i.e. ``version_added: "2.3"``.
For complex nested returns type can be specified as ``type: complex``.