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

Documentation: add parameter types, and version_added for return values and facts (#41999)

Browse source 
* Add types for parameters.

* Add version_added for return facts and return values.
This commit is contained in:
Felix Fontein 2018-06-28 19:26:14 +02:00 committed by Alicia Cozine
parent 4a05b6c8ba
commit fb0b804988
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/templates/plugin.rst.j2 vendored
View file

@ -118,6 +118,7 @@ Parameters
{# parameter name with required and/or introduced label #}
<td colspan="@{ from_kludge_ns('maxdepth') - loop.depth0 }@">
<b>@{ key }@</b>
{% if value.get('type', None) %}<br/><div style="font-size: small; color: red">@{ value.type }@</div>{% endif %}
{% if value.get('required', False) %}<br/><div style="font-size: small; color: red">required</div>{% endif %}
{% if value.version_added %}<br/><div style="font-size: small; color: darkgreen">(added in @{value.version_added}@)</div>{% endif %}
</td>
@ -270,6 +271,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
<td colspan="@{ from_kludge_ns('maxdepth') - loop.depth0 }@" colspan="@{ from_kludge_ns('maxdepth') - loop.depth0 }@">
<b>@{ key }@</b>
<br/><div style="font-size: small; color: red">@{ value.type }@</div>
{% if value.version_added %}<br/><div style="font-size: small; color: darkgreen">(added in @{value.version_added}@)</div>{% endif %}
</td>
<td>@{ value.returned | html_ify }@</td>
<td>
@ -341,6 +343,7 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
<td colspan="@{ from_kludge_ns('maxdepth') - loop.depth0 }@">
<b>@{ key }@</b>
<br/><div style="font-size: small; color: red">@{ value.type }@</div>
{% if value.version_added %}<br/><div style="font-size: small; color: darkgreen">(added in @{value.version_added}@)</div>{% endif %}
</td>
<td>@{ value.returned | html_ify }@</td>
<td>