From 89d33bbd7b0f431da9ff568328ad78d5e0407d46 Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Thu, 3 Oct 2024 15:30:49 +0300 Subject: [PATCH] [PR #8971/7fc7af30 backport][stable-9] fix doc for cmd_runner_fmt.as_bool() (#8974) fix doc for cmd_runner_fmt.as_bool() (#8971) (cherry picked from commit 7fc7af306c973c0f3a8d6900f16209b6555d307a) Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> --- docs/docsite/rst/guide_cmdrunner.rst | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) 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 |