mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Move notes higher up in order (#36815)
So people reading the module documentation usually look for parameters first, and are interested in examples. However the notes are at the very end even below the Return Values (the least interesting part). So this change moves the notes higher up, below parameters, but before examples so people at least see the notes.
This commit is contained in:
parent
6633eaa2c1
commit
974c50a417
1 changed files with 13 additions and 13 deletions
26
docs/templates/plugin.rst.j2
vendored
26
docs/templates/plugin.rst.j2
vendored
|
@ -187,6 +187,19 @@ Options
|
|||
</table>
|
||||
</br>
|
||||
|
||||
{% endif %}
|
||||
{% if notes -%}
|
||||
|
||||
|
||||
Notes
|
||||
-----
|
||||
|
||||
.. note::
|
||||
{% for note in notes %}
|
||||
- @{ note | convert_symbols_to_format }@
|
||||
{% endfor %}
|
||||
|
||||
|
||||
{% endif %}
|
||||
{% if examples or plainexamples -%}
|
||||
|
||||
|
@ -266,19 +279,6 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
|
|||
{% endif %}
|
||||
|
||||
|
||||
{% if notes -%}
|
||||
|
||||
|
||||
Notes
|
||||
-----
|
||||
|
||||
.. note::
|
||||
{% for note in notes %}
|
||||
- @{ note | convert_symbols_to_format }@
|
||||
{% endfor %}
|
||||
|
||||
|
||||
{% endif %}
|
||||
{% if author is defined -%}
|
||||
|
||||
|
||||
|
|
Loading…
Reference in a new issue