Blob Blame History Raw
From 4b406de19ae66263c3623d82db6b93d7d112018a Mon Sep 17 00:00:00 2001
From: Matt Davis <mrd@redhat.com>
Date: Fri, 23 Mar 2018 05:04:13 -0700
Subject: [PATCH] pick up missing plugin docs boolean coercion backport

---
 docs/templates/plugin.rst.j2 | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)

diff --git a/docs/templates/plugin.rst.j2 b/docs/templates/plugin.rst.j2
index 106d82b64ff..2572232c79c 100644
--- a/docs/templates/plugin.rst.j2
+++ b/docs/templates/plugin.rst.j2
@@ -107,7 +107,7 @@ Parameters
                 {# default / choices #}
                 <td>
                     <div class="cell-border">
-                        {# Recalculate choices and boolean values #}
+                        {# Turn boolean values in 'yes' and 'no' values #}
                         {% if value.default is defined %}
                             {% if value.default == true %}
                                 {% set _x = value.update({'default': 'yes'}) %}
@@ -122,10 +122,16 @@ Parameters
                         {% if value.choices %}
                             <ul><b>Choices:</b>
                                 {% for choice in value.choices %}
-                                    {% if (value.default is string and choice == value.default) or (value.default is iterable and choice in value.default) %}
-                                        <li type="disc"><div style="color: blue"><b>@{ choice | escape }@</b>&nbsp;&larr;</div></li>
+                                    {# Turn boolean values in 'yes' and 'no' values #}
+                                    {% if choice == true %}
+                                        {% set choice = 'yes' %}
+                                    {% elif choice == false %}
+                                        {% set choice = 'no' %}
+                                    {% endif %}
+                                    {% if (value.default is string and value.default == choice) or (value.default is iterable and value.default is not string and choice in value.default) %}
+                                        <li><div style="color: blue"><b>@{ choice | escape }@</b>&nbsp;&larr;</div></li>
                                     {% else %}
-                                        <li type="circle">@{ choice | escape }@</li>
+                                        <li>@{ choice | escape }@</li>
                                     {% endif %}
                                 {% endfor %}
                             </ul>
@@ -305,7 +311,6 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
                     <div class="outer-elbow-container">
                         {% for i in range(1, loop.depth) %}
                             <div class="elbow-placeholder">&nbsp;</div>
-                            </div>
                         {% endfor %}
                         <div class="elbow-key">
                             <b>@{ key }@</b>
@@ -324,9 +329,9 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
                             {% endfor %}
                         {% endif %}
                         <br/>
-                        {% if value.sample is defined  and value.sample %}
+                        {% if value.sample is defined and value.sample %}
                             <div style="font-size: smaller"><b>Sample:</b></div>
-                            {# TODO: The sample should be escaped, using | escape or | htmlify, but both mess things up beyond repair with dicts #}
+                            {# TODO: The sample should be escaped, using |escape or |htmlify, but both mess things up beyond repair with dicts #}
                             <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">@{ value.sample | replace('\n', '\n    ') | html_ify }@</div>
                         {% endif %}
                     </div>