Plugin docs: add note on precedence

src/antsibull_docs/data/docsite/ansible-docsite/macros/parameters.rst.j2

@@ -143,13 +143,13 @@
 {%       endif %}
 @{       deprecates_rst(env['deprecated'], collection, 8, role_entrypoint=role_entrypoint) }@
 {%     endfor %}
-{%     for myvar in value['vars'] %}
-      - Variable: @{ myvar['name'] | rst_escape }@
-{%       if myvar['version_added'] is still_relevant(collection=myvar['version_added_collection'] or collection) %}
+{%     for mycli in value['cli'] %}
+      - CLI argument: @{ mycli['option'] | rst_escape }@
+{%       if mycli['version_added'] is still_relevant(collection=mycli['version_added_collection'] or collection) %}
 
-        :ansible-option-versionadded:`added in @{ version_added_rst(myvar['version_added'], myvar['version_added_collection'] or collection) }@`
+        :ansible-option-versionadded:`added in @{ version_added_rst(mycli['version_added'], mycli['version_added_collection'] or collection) }@`
 {%       endif %}
-@{       deprecates_rst(myvar['deprecated'], collection, 8, role_entrypoint=role_entrypoint) }@
+@{       deprecates_rst(mycli['deprecated'], collection, 8, role_entrypoint=role_entrypoint) }@
 {%     endfor %}
 {%     for kw in value['keyword'] %}
       - Keyword: @{ kw['name'] | rst_escape }@
@@ -159,13 +159,13 @@
 {%       endif %}
 @{       deprecates_rst(kw['deprecated'], collection, 8, role_entrypoint=role_entrypoint) }@
 {%     endfor %}
-{%     for mycli in value['cli'] %}
-      - CLI argument: @{ mycli['option'] | rst_escape }@
-{%       if mycli['version_added'] is still_relevant(collection=mycli['version_added_collection'] or collection) %}
+{%     for myvar in value['vars'] %}
+      - Variable: @{ myvar['name'] | rst_escape }@
+{%       if myvar['version_added'] is still_relevant(collection=myvar['version_added_collection'] or collection) %}
 
-        :ansible-option-versionadded:`added in @{ version_added_rst(mycli['version_added'], mycli['version_added_collection'] or collection) }@`
+        :ansible-option-versionadded:`added in @{ version_added_rst(myvar['version_added'], myvar['version_added_collection'] or collection) }@`
 {%       endif %}
-@{       deprecates_rst(mycli['deprecated'], collection, 8, role_entrypoint=role_entrypoint) }@
+@{       deprecates_rst(myvar['deprecated'], collection, 8, role_entrypoint=role_entrypoint) }@
 {%     endfor %}
 {%   endif %}
 
@@ -268,13 +268,13 @@
 @{       deprecates_html(env['deprecated'], collection, role_entrypoint=role_entrypoint) }@
       </li>
 {%     endfor %}
-{%     for myvar in value['vars'] %}
+{%     for mycli in value['cli'] %}
       <li>
-        <p>Variable: @{ myvar['name'] | escape }@</p>
-{%       if myvar['version_added'] is still_relevant(collection=myvar['version_added_collection'] or collection) %}
-        <p><em class="ansible-option-versionadded">added in @{ version_added_html(myvar['version_added'], myvar['version_added_collection'] or collection) }@</em></p>
+        <p>CLI argument: @{ mycli['option'] | escape }@</p>
+{%       if mycli['version_added'] is still_relevant(collection=mycli['version_added_collection'] or collection) %}
+        <p><em class="ansible-option-versionadded">added in @{ version_added_html(mycli['version_added'], mycli['version_added_collection'] or collection) }@</em></p>
 {%       endif %}
-@{       deprecates_html(myvar['deprecated'], collection, role_entrypoint=role_entrypoint) }@
+@{       deprecates_html(mycli['deprecated'], collection, role_entrypoint=role_entrypoint) }@
       </li>
 {%     endfor %}
 {%     for kw in value['keyword'] %}
@@ -286,13 +286,13 @@
 @{       deprecates_html(kw['deprecated'], collection, role_entrypoint=role_entrypoint) }@
       </li>
 {%     endfor %}
-{%     for mycli in value['cli'] %}
+{%     for myvar in value['vars'] %}
       <li>
-        <p>CLI argument: @{ mycli['option'] | escape }@</p>
-{%       if mycli['version_added'] is still_relevant(collection=mycli['version_added_collection'] or collection) %}
-        <p><em class="ansible-option-versionadded">added in @{ version_added_html(mycli['version_added'], mycli['version_added_collection'] or collection) }@</em></p>
+        <p>Variable: @{ myvar['name'] | escape }@</p>
+{%       if myvar['version_added'] is still_relevant(collection=myvar['version_added_collection'] or collection) %}
+        <p><em class="ansible-option-versionadded">added in @{ version_added_html(myvar['version_added'], myvar['version_added_collection'] or collection) }@</em></p>
 {%       endif %}
-@{       deprecates_html(mycli['deprecated'], collection, role_entrypoint=role_entrypoint) }@
+@{       deprecates_html(myvar['deprecated'], collection, role_entrypoint=role_entrypoint) }@
       </li>
 {%     endfor %}
       </ul>

src/antsibull_docs/data/docsite/ansible-docsite/plugin.rst.j2

@@ -262,6 +262,15 @@ Parameters
 @{     parameters_rst(doc['options'] | remove_options_from_list(options_to_skip) | dictsort, suboption_key='suboptions') }@
 {%   endif %}
 {% endif %}
+{% if plugin_type != 'module' %}
+
+.. note::
+
+    Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
+    For example, a variable that is lower in the list will override a variable that is higher up.
+    The entry types are also ordered by precedence from low to high priority order.
+    For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+{% endif %}
 
 .. Attributes
 

src/antsibull_docs/data/docsite/simplified-rst/macros/parameters.rst.j2

@@ -100,13 +100,13 @@
 @{       deprecates_html(env['deprecated'], collection, role_entrypoint=role_entrypoint) }@
       </li>
 {%     endfor %}
-{%     for myvar in value['vars'] %}
+{%     for mycli in value['cli'] %}
       <li>
-        <p>Variable: @{ myvar['name'] | escape }@</p>
-{%       if myvar['version_added'] is still_relevant(collection=myvar['version_added_collection'] or collection) %}
-        <p><i style="font-size: small; color: darkgreen;">added in @{ version_added_html(myvar['version_added'], myvar['version_added_collection'] or collection) }@</i></p>
+        <p>CLI argument: @{ mycli['option'] | escape }@</p>
+{%       if mycli['version_added'] is still_relevant(collection=mycli['version_added_collection'] or collection) %}
+        <p><i style="font-size: small; color: darkgreen;">added in @{ version_added_html(mycli['version_added'], mycli['version_added_collection'] or collection) }@</i></p>
 {%       endif %}
-@{       deprecates_html(myvar['deprecated'], collection, role_entrypoint=role_entrypoint) }@
+@{       deprecates_html(mycli['deprecated'], collection, role_entrypoint=role_entrypoint) }@
       </li>
 {%     endfor %}
 {%     for kw in value['keyword'] %}
@@ -118,13 +118,13 @@
 @{       deprecates_html(kw['deprecated'], collection, role_entrypoint=role_entrypoint) }@
       </li>
 {%     endfor %}
-{%     for mycli in value['cli'] %}
+{%     for myvar in value['vars'] %}
       <li>
-        <p>CLI argument: @{ mycli['option'] | escape }@</p>
-{%       if mycli['version_added'] is still_relevant(collection=mycli['version_added_collection'] or collection) %}
-        <p><i style="font-size: small; color: darkgreen;">added in @{ version_added_html(mycli['version_added'], mycli['version_added_collection'] or collection) }@</i></p>
+        <p>Variable: @{ myvar['name'] | escape }@</p>
+{%       if myvar['version_added'] is still_relevant(collection=myvar['version_added_collection'] or collection) %}
+        <p><i style="font-size: small; color: darkgreen;">added in @{ version_added_html(myvar['version_added'], myvar['version_added_collection'] or collection) }@</i></p>
 {%       endif %}
-@{       deprecates_html(mycli['deprecated'], collection, role_entrypoint=role_entrypoint) }@
+@{       deprecates_html(myvar['deprecated'], collection, role_entrypoint=role_entrypoint) }@
       </li>
 {%     endfor %}
       </ul>

src/antsibull_docs/data/docsite/simplified-rst/plugin.rst.j2

@@ -197,6 +197,15 @@ Parameters
 
 @{   parameters_html(doc['options'] | remove_options_from_list(options_to_skip) | dictsort, suboption_key='suboptions') }@
 {% endif %}
+{% if plugin_type != 'module' %}
+
+.. note::
+
+    Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
+    For example, a variable that is lower in the list will override a variable that is higher up.
+    The entry types are also ordered by precedence from low to high priority order.
+    For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+{% endif %}
 
 {% if doc['attributes'] %}
 

tests/functional/baseline-default/collections/ns2/col/bar_filter.rst

@@ -300,6 +300,13 @@ example: ``input | ns2.col.bar(key1=value1, key2=value2, ...)``
         </div>
 
 
+.. note::
+
+    Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
+    For example, a variable that is lower in the list will override a variable that is higher up.
+    The entry types are also ordered by precedence from low to high priority order.
+    For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+
 .. Attributes
 
 

tests/functional/baseline-default/collections/ns2/col/bar_test.rst

@@ -121,6 +121,13 @@ This describes the input of the test, the value before ``is ns2.col.bar`` or ``i
 .. Options
 
 
+.. note::
+
+    Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
+    For example, a variable that is lower in the list will override a variable that is higher up.
+    The entry types are also ordered by precedence from low to high priority order.
+    For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+
 .. Attributes
 
 

tests/functional/baseline-default/collections/ns2/col/foo_become.rst

@@ -218,6 +218,8 @@ Parameters
         Alternative: nothing
 
 
+      - Keyword: become\_exe
+
       - Variable: ansible\_become\_exe
 
       - Variable: ansible\_foo\_exe
@@ -229,8 +231,6 @@ Parameters
         Alternative: nothing
 
 
-      - Keyword: become\_exe
-
 
       .. raw:: html
 
@@ -299,13 +299,13 @@ Parameters
 
       - Environment variable: :envvar:`ANSIBLE\_FOO\_USER`
 
-      - Variable: ansible\_become\_user
-
-      - Variable: ansible\_foo\_user
+      - Keyword: become\_user
 
         :ansible-option-versionadded:`added in ns2.col 0.1.0`
 
-      - Keyword: become\_user
+      - Variable: ansible\_become\_user
+
+      - Variable: ansible\_foo\_user
 
         :ansible-option-versionadded:`added in ns2.col 0.1.0`
 
@@ -315,6 +315,13 @@ Parameters
         </div>
 
 
+.. note::
+
+    Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
+    For example, a variable that is lower in the list will override a variable that is higher up.
+    The entry types are also ordered by precedence from low to high priority order.
+    For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+
 .. Attributes
 
 

tests/functional/baseline-default/collections/ns2/col/foo_cache.rst

@@ -169,6 +169,13 @@ Parameters
         </div>
 
 
+.. note::
+
+    Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
+    For example, a variable that is lower in the list will override a variable that is higher up.
+    The entry types are also ordered by precedence from low to high priority order.
+    For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+
 .. Attributes
 
 

tests/functional/baseline-default/collections/ns2/col/foo_callback.rst

@@ -123,6 +123,13 @@ Parameters
         </div>
 
 
+.. note::
+
+    Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
+    For example, a variable that is lower in the list will override a variable that is higher up.
+    The entry types are also ordered by precedence from low to high priority order.
+    For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+
 .. Attributes
 
 

tests/functional/baseline-default/collections/ns2/col/foo_cliconf.rst

@@ -63,6 +63,13 @@ Synopsis
 .. Options
 
 
+.. note::
+
+    Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
+    For example, a variable that is lower in the list will override a variable that is higher up.
+    The entry types are also ordered by precedence from low to high priority order.
+    For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+
 .. Attributes
 
 

tests/functional/baseline-default/collections/ns2/col/foo_connection.rst

@@ -173,6 +173,13 @@ Parameters
         </div>
 
 
+.. note::
+
+    Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
+    For example, a variable that is lower in the list will override a variable that is higher up.
+    The entry types are also ordered by precedence from low to high priority order.
+    For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+
 .. Attributes
 
 

tests/functional/baseline-default/collections/ns2/col/foo_filter.rst

@@ -214,6 +214,13 @@ example: ``input | ns2.col.foo(key1=value1, key2=value2, ...)``
         </div>
 
 
+.. note::
+
+    Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
+    For example, a variable that is lower in the list will override a variable that is higher up.
+    The entry types are also ordered by precedence from low to high priority order.
+    For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+
 .. Attributes
 
 

tests/functional/baseline-default/collections/ns2/col/foo_inventory.rst

@@ -117,6 +117,13 @@ Parameters
         </div>
 
 
+.. note::
+
+    Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
+    For example, a variable that is lower in the list will override a variable that is higher up.
+    The entry types are also ordered by precedence from low to high priority order.
+    For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+
 .. Attributes
 
 

tests/functional/baseline-default/collections/ns2/col/foo_lookup.rst

@@ -176,6 +176,13 @@ examples: ``lookup('ns2.col.foo', key1=value1, key2=value2, ...)`` and ``query('
         </div>
 
 
+.. note::
+
+    Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
+    For example, a variable that is lower in the list will override a variable that is higher up.
+    The entry types are also ordered by precedence from low to high priority order.
+    For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+
 .. Attributes
 
 

tests/functional/baseline-default/collections/ns2/col/foo_shell.rst

@@ -180,6 +180,13 @@ Parameters
         </div>
 
 
+.. note::
+
+    Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
+    For example, a variable that is lower in the list will override a variable that is higher up.
+    The entry types are also ordered by precedence from low to high priority order.
+    For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+
 .. Attributes
 
 

tests/functional/baseline-default/collections/ns2/col/foo_strategy.rst

@@ -66,6 +66,13 @@ Synopsis
 .. Options
 
 
+.. note::
+
+    Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
+    For example, a variable that is lower in the list will override a variable that is higher up.
+    The entry types are also ordered by precedence from low to high priority order.
+    For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+
 .. Attributes
 
 

tests/functional/baseline-default/collections/ns2/col/foo_test.rst

@@ -174,6 +174,13 @@ examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is
         </div>
 
 
+.. note::
+
+    Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
+    For example, a variable that is lower in the list will override a variable that is higher up.
+    The entry types are also ordered by precedence from low to high priority order.
+    For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+
 .. Attributes
 
 

tests/functional/baseline-default/collections/ns2/col/foo_vars.rst

@@ -184,6 +184,13 @@ Parameters
         </div>
 
 
+.. note::
+
+    Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
+    For example, a variable that is lower in the list will override a variable that is higher up.
+    The entry types are also ordered by precedence from low to high priority order.
+    For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+
 .. Attributes
 
 

tests/functional/baseline-no-breadcrumbs/collections/ns2/col/bar_filter.rst

@@ -300,6 +300,13 @@ example: ``input | ns2.col.bar(key1=value1, key2=value2, ...)``
         </div>
 
 
+.. note::
+
+    Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
+    For example, a variable that is lower in the list will override a variable that is higher up.
+    The entry types are also ordered by precedence from low to high priority order.
+    For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+
 .. Attributes