Add 'True' string #2489
Add 'True' string #2489
Conversation
Requested to add `True` string to the Truthy values list.
| Valid values Description | ||
| =============================================================================================== ==================================================================== | ||
| ``True`` , ``'true'`` , ``'t'`` , ``'yes'`` , ``'y'`` , ``'on'`` , ``'1'`` , ``1`` , ``1.0`` Truthy values | ||
| ========================================================================================================== ==================================================================== |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
@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?
| ========================================================================================================== ==================================================================== | ||
| Valid values Description | ||
| ========================================================================================================== ==================================================================== | ||
| ``True`` , ``'True'``, ``'true'`` , ``'t'`` , ``'yes'`` , ``'y'`` , ``'on'`` , ``'1'`` , ``1`` , ``1.0`` Truthy values |
There was a problem hiding this comment.
Why add 'True' instead of mentioning that the string values are case insensitive? Otherwise we're leaving out things like 'TRUE', 'truE', etc.
Requested to add
Truestring to the Truthy values list.