Improve module docs wrt. required params (#36812)

So I am still not satisfied with how required parameters are being
displayed (before it was yes/no, then it became required/optional, and
only required).

Now it will display in small green 'required' under the parameter name.
This is more convenient, and provides more room for the description.
Especially on smaller screens.
pull/36882/head
Dag Wieers 7 years ago committed by scottb
parent 974c50a417
commit 38abda544f

@ -91,7 +91,6 @@ Options
{# Header of the documentation #} {# Header of the documentation #}
<tr> <tr>
<th class="head"><div class="cell-border">Parameter</div></th> <th class="head"><div class="cell-border">Parameter</div></th>
<th class="head"><div class="cell-border">Required?</div></th>
<th class="head"><div class="cell-border">Default</div></th> <th class="head"><div class="cell-border">Default</div></th>
<th class="head"><div class="cell-border">Choices</div></th> <th class="head"><div class="cell-border">Choices</div></th>
{% if plugin_type != 'module' %} {% if plugin_type != 'module' %}
@ -109,12 +108,12 @@ Options
</div> </div>
{% endfor %} {% endfor %}
<div class="elbow-key"> <div class="elbow-key">
<b>@{ key }@</b><br/><div style="font-size: small;">{% if value.version_added %} (added in @{value.version_added}@){% endif %}</div> <b>@{ key }@</b>
{% if value.get('required', False) %}<br/><div style="font-size: small; color: red">required</div>{% endif %}
{% if value.version_added %}<br/><div style="font-size: small; color: darkgreen">(added in @{value.version_added}@)</div>{% endif %}
</div> </div>
<div class="outer-elbow-container"> <div class="outer-elbow-container">
</td> </td>
{# required #}
<td><div class="cell-border">{% if value.get('required', False) %}required{% endif %}</div></td>
{# default value #} {# default value #}
<td><div class="cell-border">{% if value.default %}@{ value.default | html_ify }@{% endif %}</div></td> <td><div class="cell-border">{% if value.default %}@{ value.default | html_ify }@{% endif %}</div></td>
{# choices #} {# choices #}

Loading…
Cancel
Save