Mirrors/yamllint
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clarify documentation on the 'truthy' rule

Browse Source 
I like the 'truthy' rule but its documentation and message have confused several of my colleagues. I've tried rewriting it to be clearer.
This commit is contained in:
Adam Johnson
2018-04-05 15:41:25 +01:00
committed by Adrien Vergé
parent 3bdc1b6e1b
commit 36b4776778
1 changed files with 8 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
yamllint/rules/truthy.py
View File

@@ -15,11 +15,12 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
""" """
Use this rule to forbid truthy values that are not quoted nor explicitly typed. Use this rule to forbid non-explictly typed truthy values other than ``true``
and ``false``, for example ``YES``, ``False`` and ``off``.
This would prevent YAML parsers from transforming ``[yes, FALSE, Off]`` into This can be useful to prevent surprises from YAML parsers transforming
``[true, false, false]`` or ``{y: 1, yes: 2, on: 3, true: 4, True: 5}`` into ``[yes, FALSE, Off]`` into ``[true, false, false]`` or
``{y: 1, true: 5}``. ``{y: 1, yes: 2, on: 3, true: 4, True: 5}`` into ``{y: 1, true: 5}``.
.. rubric:: Examples .. rubric:: Examples
@@ -34,8 +35,7 @@ This would prevent YAML parsers from transforming ``[yes, FALSE, Off]`` into
"yes": 1 "yes": 1
"on": 2 "on": 2
"true": 3 "True": 3
"True": 4
explicit: explicit:
string1: !!str True string1: !!str True
@@ -62,8 +62,7 @@ This would prevent YAML parsers from transforming ``[yes, FALSE, Off]`` into
yes: 1 yes: 1
on: 2 on: 2
true: 3 True: 3
True: 4
""" """
import yaml import yaml
@@ -90,4 +89,4 @@ def check(conf, token, prev, next, nextnext, context):
if token.value in TRUTHY and token.style is None: if token.value in TRUTHY and token.style is None:
yield LintProblem(token.start_mark.line + 1, yield LintProblem(token.start_mark.line + 1,
token.start_mark.column + 1, token.start_mark.column + 1,
"truthy value is not quoted") "truthy value should be true or false")