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:
Dag Wieers 2018-02-28 17:58:49 +01:00 committed by scottb
parent 6633eaa2c1
commit 974c50a417

View file

@ -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 -%}