From 974c50a417961ec9954bbda030e26bc68a9ab254 Mon Sep 17 00:00:00 2001 From: Dag Wieers Date: Wed, 28 Feb 2018 17:58:49 +0100 Subject: [PATCH] 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. --- docs/templates/plugin.rst.j2 | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/templates/plugin.rst.j2 b/docs/templates/plugin.rst.j2 index 47d7aa0214..48b62b3756 100644 --- a/docs/templates/plugin.rst.j2 +++ b/docs/templates/plugin.rst.j2 @@ -187,6 +187,19 @@ Options
+{% 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 `, the foll {% endif %} -{% if notes -%} - - -Notes ------ - -.. note:: -{% for note in notes %} - - @{ note | convert_symbols_to_format }@ -{% endfor %} - - -{% endif %} {% if author is defined -%}