Skip to content

Add 'True' string #2489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from
+6 −6
Open

Add 'True' string #2489

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/docsite/rst/playbook_guide/playbooks_variables.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,14 +112,14 @@ While documentation examples focus on ``true/false`` to be compatible with ``ans
.. table::
:class: documentation-table

=============================================================================================== ====================================================================
Valid values Description
=============================================================================================== ====================================================================
``True`` , ``'true'`` , ``'t'`` , ``'yes'`` , ``'y'`` , ``'on'`` , ``'1'`` , ``1`` , ``1.0`` Truthy values
========================================================================================================== ====================================================================
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this table is being updated, it would be good to correct the introductory paragraph to mention that this only applies to bool module arguments.

As currently written, this section makes it seem like these rules apply to variables in general, and to parsing of playbooks, inventory, etc. There may even be a better place in the documentation for this table, since it's not about variables, but module arguments.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mattclay getting back to this pr (finally). We don't talk a lot about module arguments in the docs that I can find. We do have https://docs.ansible.com/ansible/latest/module_plugin_guide/modules_intro.html where we could move this section to (Booleans in module arguments could be the new section title). What do you think?

And if I move it, is there any need to have any replacement text left here for how booleans are handled in variables in general?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that's an acceptable location to move it to.

There's not really anything to document here about boolean variables, at least not for 2.19+, since Jinja native types are always used. There are boolean behaviors that could be documented elsewhere, but they're not specific to variables.

Valid values Description
========================================================================================================== ====================================================================
``True`` , ``'True'``, ``'true'`` , ``'t'`` , ``'yes'`` , ``'y'`` , ``'on'`` , ``'1'`` , ``1`` , ``1.0`` Truthy values
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why add 'True' instead of mentioning that the string values are case insensitive? Otherwise we're leaving out things like 'TRUE', 'truE', etc.


``False`` , ``'false'`` , ``'f'`` , ``'no'`` , ``'n'`` , ``'off'`` , ``'0'`` , ``0`` , ``0.0`` Falsy values
``False`` , ``'false'`` , ``'f'`` , ``'no'`` , ``'n'`` , ``'off'`` , ``'0'`` , ``0`` , ``0.0`` Falsy values

=============================================================================================== ====================================================================
========================================================================================================== ====================================================================

.. _list_variables:

Expand Down