diff --git a/docs/docsite/rst/guide_cmdrunner.rst b/docs/docsite/rst/guide_cmdrunner.rst index d491769c18..f7b70a86e1 100644 --- 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 |