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

2024-10-04 01:19:13 +13:00 · 2024-10-04 01:19:13 +13:00 · 7fc7af306c
parent c4e2b73193
commit 7fc7af306c
1 changed files with 13 additions and 1 deletions
--- 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              |