ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-09 04:00:31 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

[PR #8971/7fc7af30 backport][stable-9] fix doc for cmd_runner_fmt.as_bool() (#8974)

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

(cherry picked from commit 7fc7af306c)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot] 2024-10-03 15:30:49 +03:00 • committed by GitHub
parent 76b6c8e184
commit 89d33bbd7b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 13 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/docsite/rst/guide_cmdrunner.rst
View file

@ -186,8 +186,20 @@ In these descriptions ``value`` refers to the single parameter passed to the for
+------------+--------------------+ +------------+--------------------+
| ``False`` | ``[]`` | | ``False`` | ``[]`` |
+------------+--------------------+ +------------+--------------------+
- Creation (two args): - Creation (two args, ``None`` treated as ``False``):
``cmd_runner_fmt.as_bool("--relax", "--dont-do-it")`` ``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: - Examples:
+------------+----------------------+ +------------+----------------------+
| Value | Outcome | | Value | Outcome |