From fb0b80498823ccc6d3b57f6764627743da3e6cff Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Thu, 28 Jun 2018 19:26:14 +0200 Subject: [PATCH] Documentation: add parameter types, and version_added for return values and facts (#41999) * Add types for parameters. * Add version_added for return facts and return values. --- docs/templates/plugin.rst.j2 | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/templates/plugin.rst.j2 b/docs/templates/plugin.rst.j2 index c385ac9c635..79300594f2f 100644 --- a/docs/templates/plugin.rst.j2 +++ b/docs/templates/plugin.rst.j2 @@ -118,6 +118,7 @@ Parameters {# parameter name with required and/or introduced label #} @{ key }@ + {% if value.get('type', None) %}
@{ value.type }@
{% endif %} {% if value.get('required', False) %}
required
{% endif %} {% if value.version_added %}
(added in @{value.version_added}@)
{% endif %} @@ -270,6 +271,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a @{ key }@
@{ value.type }@
+ {% if value.version_added %}
(added in @{value.version_added}@)
{% endif %} @{ value.returned | html_ify }@ @@ -341,6 +343,7 @@ Common return values are documented :ref:`here `, the foll @{ key }@
@{ value.type }@
+ {% if value.version_added %}
(added in @{value.version_added}@)
{% endif %} @{ value.returned | html_ify }@