Make sure to mention collection version for version_added as well. (#73270)
This commit is contained in:
parent
1e27d4052a
commit
73aa571305
3 changed files with 7 additions and 5 deletions
|
@ -114,7 +114,8 @@ All fields in the ``DOCUMENTATION`` block are lower-case. All fields are require
|
||||||
:version_added:
|
:version_added:
|
||||||
|
|
||||||
* The version of Ansible when the module was added.
|
* The version of Ansible when the module was added.
|
||||||
* This is a string, and not a float, for example, ``version_added: '2.1'``
|
* This is a string, and not a float, for example, ``version_added: '2.1'``.
|
||||||
|
* In collections, this must be the collection version the module was added to, not the Ansible version. For example, ``version_added: 1.0.0``.
|
||||||
|
|
||||||
:author:
|
:author:
|
||||||
|
|
||||||
|
@ -182,6 +183,7 @@ All fields in the ``DOCUMENTATION`` block are lower-case. All fields are require
|
||||||
|
|
||||||
* Only needed if this option was extended after initial Ansible release, in other words, this is greater than the top level `version_added` field.
|
* Only needed if this option was extended after initial Ansible release, in other words, this is greater than the top level `version_added` field.
|
||||||
* This is a string, and not a float, for example, ``version_added: '2.3'``.
|
* This is a string, and not a float, for example, ``version_added: '2.3'``.
|
||||||
|
* In collections, this must be the collection version the option was added to, not the Ansible version. For example, ``version_added: 1.0.0``.
|
||||||
|
|
||||||
:suboptions:
|
:suboptions:
|
||||||
|
|
||||||
|
|
|
@ -221,7 +221,7 @@ but with an extra option so you can see how configuration works in Ansible versi
|
||||||
requirements:
|
requirements:
|
||||||
- enable in configuration
|
- enable in configuration
|
||||||
short_description: Adds time to play stats
|
short_description: Adds time to play stats
|
||||||
version_added: "2.0"
|
version_added: "2.0" # for collections, use the collection version, not the Ansible version
|
||||||
description:
|
description:
|
||||||
- This callback just adds total play duration to the play stats.
|
- This callback just adds total play duration to the play stats.
|
||||||
options:
|
options:
|
||||||
|
@ -339,7 +339,7 @@ Here's a simple lookup plugin implementation --- this lookup returns the content
|
||||||
DOCUMENTATION = """
|
DOCUMENTATION = """
|
||||||
lookup: file
|
lookup: file
|
||||||
author: Daniel Hokka Zakrisson <daniel@hozac.com>
|
author: Daniel Hokka Zakrisson <daniel@hozac.com>
|
||||||
version_added: "0.9"
|
version_added: "0.9" # for collections, use the collection version, not the Ansible version
|
||||||
short_description: read file contents
|
short_description: read file contents
|
||||||
description:
|
description:
|
||||||
- This lookup returns the contents from a file on the Ansible controller's file system.
|
- This lookup returns the contents from a file on the Ansible controller's file system.
|
||||||
|
@ -468,7 +468,7 @@ Include the ``vars_plugin_staging`` documentation fragment to allow users to det
|
||||||
|
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
vars: custom_hostvars
|
vars: custom_hostvars
|
||||||
version_added: "2.10"
|
version_added: "2.10" # for collections, use the collection version, not the Ansible version
|
||||||
short_description: Load custom host vars
|
short_description: Load custom host vars
|
||||||
description: Load custom host vars
|
description: Load custom host vars
|
||||||
options:
|
options:
|
||||||
|
|
|
@ -167,7 +167,7 @@ For example, the resource model builder includes the ``myos_interfaces.yml`` sam
|
||||||
description:
|
description:
|
||||||
- The some_int.
|
- The some_int.
|
||||||
type: int
|
type: int
|
||||||
version_added: '1.1'
|
version_added: '1.1.0'
|
||||||
some_dict:
|
some_dict:
|
||||||
type: dict
|
type: dict
|
||||||
description:
|
description:
|
||||||
|
|
Loading…
Reference in a new issue