diff options
| author | Felix Fontein <felix@fontein.de> | 2019-10-11 20:59:15 +0200 |
|---|---|---|
| committer | Alicia Cozine <879121+acozine@users.noreply.github.com> | 2019-10-11 13:59:15 -0500 |
| commit | 054285c34ce05ce0f28626e7f5d1964b93aa4c0d (patch) | |
| tree | 1da0ca74882537ed2660a91471b7cef595bfbd63 /docs/templates | |
| parent | ae265bc5464a89935bfe1be6af050b94e09b6eb9 (diff) | |
| download | ansible-054285c34ce05ce0f28626e7f5d1964b93aa4c0d.tar.gz | |
crypto modules: improve return value list documentation (#62929)
* Improve return value documentation by allowing entry for return values.
* Add docs formatting, adjust styling.
* Fix sample return value. (Taken from https://tools.ietf.org/html/rfc7517#appendix-A.1.)
* Work around abuse of .
Diffstat (limited to 'docs/templates')
| -rw-r--r-- | docs/templates/plugin.rst.j2 | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/templates/plugin.rst.j2 b/docs/templates/plugin.rst.j2 index d8ea4800ed..0d974f2cca 100644 --- a/docs/templates/plugin.rst.j2 +++ b/docs/templates/plugin.rst.j2 @@ -288,7 +288,10 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a {% endfor %} <td colspan="@{ from_kludge_ns('maxdepth') - loop.depth0 }@" colspan="@{ from_kludge_ns('maxdepth') - loop.depth0 }@"> <b>@{ key }@</b> - <div style="font-size: small; color: purple">@{ value.type | documented_type }@</div> + <div style="font-size: small"> + <span style="color: purple">@{ value.type | documented_type }@</span> + {% if value.elements %} / <span style="color: purple">elements=@{ value.elements | documented_type }@</span>{% endif %} + </div> {% if value.version_added %}<div style="font-style: italic; font-size: small; color: darkgreen">added in @{value.version_added}@</div>{% endif %} </td> <td>@{ value.returned | html_ify }@</td> @@ -360,7 +363,10 @@ Common return values are documented :ref:`here <common_return_values>`, the foll {% endfor %} <td colspan="@{ from_kludge_ns('maxdepth') - loop.depth0 }@"> <b>@{ key }@</b> - <div style="font-size: small; color: purple">@{ value.type | documented_type }@</div> + <div style="font-size: small"> + <span style="color: purple">@{ value.type | documented_type }@</span> + {% if value.elements %} / <span style="color: purple">elements=@{ value.elements | documented_type }@</span>{% endif %} + </div> {% if value.version_added %}<div style="font-style: italic; font-size: small; color: darkgreen">added in @{value.version_added}@</div>{% endif %} </td> <td>@{ value.returned | html_ify }@</td> |