fix doc for cmd_runner_fmt.as_bool() (#8971)

ansible-collections · Oct 3, 2024 · 7fc7af3 · 7fc7af3
1 parent c4e2b73
commit 7fc7af3
Showing 1 changed file with 13 additions and 1 deletion.
diff --git a/docs/docsite/rst/guide_cmdrunner.rst b/docs/docsite/rst/guide_cmdrunner.rst
@@ -186,8 +186,20 @@ In these descriptions ``value`` refers to the single parameter passed to the for
         +------------+--------------------+
         | ``False``  | ``[]``             |
         +------------+--------------------+
-    - Creation (two args):
+    - Creation (two args, ``None`` treated as ``False``):
         ``cmd_runner_fmt.as_bool("--relax", "--dont-do-it")``
+    - Examples:
+        +------------+----------------------+
+        | Value      | Outcome              |
+        +============+======================+
+        | ``True``   | ``["--relax"]``      |
+        +------------+----------------------+
+        | ``False``  | ``["--dont-do-it"]`` |
+        +------------+----------------------+
+        |            | ``["--dont-do-it"]`` |
+        +------------+----------------------+
+    - Creation (two args, ``None`` is ignored):
+        ``cmd_runner_fmt.as_bool("--relax", "--dont-do-it", ignore_none=True)``
     - Examples:
         +------------+----------------------+
         | Value      | Outcome              |