From 21e81b643564310c767d7e7397853b869fece775 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adrien=20Verg=C3=A9?= Date: Thu, 17 Nov 2016 14:27:24 +0100 Subject: [PATCH] fix(rules): Use `true`/`false`, not `yes`/`no` Although `yes` and `no` are recognized as booleans by the pyyaml parser, the correct keywords are `true` and `false` (as highlighted by the newly added `truthy` rule). This commit replaces the use of `yes`/`no` by `true`/`false` and advertise it in the docs, but also makes sure this change is backward-compatible (so that `yes` and `no` still work). --- tests/rules/test_comments.py | 14 +++++----- tests/rules/test_document_end.py | 6 ++-- tests/rules/test_document_start.py | 8 +++--- tests/rules/test_indentation.py | 44 +++++++++++++++--------------- tests/rules/test_line_length.py | 12 ++++---- tests/test_config.py | 39 ++++++++++++++++++++++++++ tests/test_spec_examples.py | 6 ++-- yamllint/conf/default.yaml | 12 ++++---- yamllint/conf/relaxed.yaml | 2 +- yamllint/rules/comments.py | 4 +-- yamllint/rules/document_end.py | 8 +++--- yamllint/rules/document_start.py | 8 +++--- yamllint/rules/indentation.py | 12 ++++---- yamllint/rules/line_length.py | 10 +++---- 14 files changed, 112 insertions(+), 73 deletions(-) diff --git a/tests/rules/test_comments.py b/tests/rules/test_comments.py index ee8a62c..ded31fa 100644 --- a/tests/rules/test_comments.py +++ b/tests/rules/test_comments.py @@ -43,7 +43,7 @@ class CommentsTestCase(RuleTestCase): def test_starting_space(self): conf = ('comments:\n' - ' require-starting-space: yes\n' + ' require-starting-space: true\n' ' min-spaces-from-content: -1\n' 'comments-indentation: disable\n') self.check('---\n' @@ -82,7 +82,7 @@ class CommentsTestCase(RuleTestCase): def test_spaces_from_content(self): conf = ('comments:\n' - ' require-starting-space: no\n' + ' require-starting-space: false\n' ' min-spaces-from-content: 2\n') self.check('---\n' '# comment\n' @@ -104,7 +104,7 @@ class CommentsTestCase(RuleTestCase): def test_both(self): conf = ('comments:\n' - ' require-starting-space: yes\n' + ' require-starting-space: true\n' ' min-spaces-from-content: 2\n' 'comments-indentation: disable\n') self.check('---\n' @@ -134,7 +134,7 @@ class CommentsTestCase(RuleTestCase): def test_empty_comment(self): conf = ('comments:\n' - ' require-starting-space: yes\n' + ' require-starting-space: true\n' ' min-spaces-from-content: 2\n') self.check('---\n' '# This is paragraph 1.\n' @@ -146,13 +146,13 @@ class CommentsTestCase(RuleTestCase): def test_first_line(self): conf = ('comments:\n' - ' require-starting-space: yes\n' + ' require-starting-space: true\n' ' min-spaces-from-content: 2\n') self.check('# comment\n', conf) def test_last_line(self): conf = ('comments:\n' - ' require-starting-space: yes\n' + ' require-starting-space: true\n' ' min-spaces-from-content: 2\n' 'new-line-at-end-of-file: disable\n') self.check('# comment with no newline char:\n' @@ -160,7 +160,7 @@ class CommentsTestCase(RuleTestCase): def test_multi_line_scalar(self): conf = ('comments:\n' - ' require-starting-space: yes\n' + ' require-starting-space: true\n' ' min-spaces-from-content: 2\n' 'trailing-spaces: disable\n') self.check('---\n' diff --git a/tests/rules/test_document_end.py b/tests/rules/test_document_end.py index 82d5772..d62a7e6 100644 --- a/tests/rules/test_document_end.py +++ b/tests/rules/test_document_end.py @@ -31,7 +31,7 @@ class DocumentEndTestCase(RuleTestCase): ' document: end\n', conf) def test_required(self): - conf = 'document-end: {present: yes}' + conf = 'document-end: {present: true}' self.check('', conf) self.check('\n', conf) self.check('---\n' @@ -43,7 +43,7 @@ class DocumentEndTestCase(RuleTestCase): ' document: end\n', conf, problem=(3, 1)) def test_forbidden(self): - conf = 'document-end: {present: no}' + conf = 'document-end: {present: false}' self.check('---\n' 'with:\n' ' document: end\n' @@ -53,7 +53,7 @@ class DocumentEndTestCase(RuleTestCase): ' document: end\n', conf) def test_multiple_documents(self): - conf = ('document-end: {present: yes}\n' + conf = ('document-end: {present: true}\n' 'document-start: disable\n') self.check('---\n' 'first: document\n' diff --git a/tests/rules/test_document_start.py b/tests/rules/test_document_start.py index 15fe2b7..20de9ad 100644 --- a/tests/rules/test_document_start.py +++ b/tests/rules/test_document_start.py @@ -28,7 +28,7 @@ class DocumentStartTestCase(RuleTestCase): 'key: val\n', conf) def test_required(self): - conf = ('document-start: {present: yes}\n' + conf = ('document-start: {present: true}\n' 'empty-lines: disable\n') self.check('', conf) self.check('\n', conf) @@ -44,7 +44,7 @@ class DocumentStartTestCase(RuleTestCase): 'key: val\n', conf) def test_forbidden(self): - conf = ('document-start: {present: no}\n' + conf = ('document-start: {present: false}\n' 'empty-lines: disable\n') self.check('', conf) self.check('key: val\n', conf) @@ -62,7 +62,7 @@ class DocumentStartTestCase(RuleTestCase): 'key: val\n', conf, problem=(2, 1)) def test_multiple_documents(self): - conf = 'document-start: {present: yes}' + conf = 'document-start: {present: true}' self.check('---\n' 'first: document\n' '...\n' @@ -85,7 +85,7 @@ class DocumentStartTestCase(RuleTestCase): 'third: document\n', conf, problem=(4, 1, 'syntax')) def test_directives(self): - conf = 'document-start: {present: yes}' + conf = 'document-start: {present: true}' self.check('%YAML 1.2\n' '---\n' 'doc: ument\n' diff --git a/tests/rules/test_indentation.py b/tests/rules/test_indentation.py index cbbc979..e435304 100644 --- a/tests/rules/test_indentation.py +++ b/tests/rules/test_indentation.py @@ -549,7 +549,7 @@ class IndentationTestCase(RuleTestCase): '...\n', conf) def test_one_space(self): - conf = 'indentation: {spaces: 1, indent-sequences: no}' + conf = 'indentation: {spaces: 1, indent-sequences: false}' self.check('---\n' 'object:\n' ' k1:\n' @@ -562,7 +562,7 @@ class IndentationTestCase(RuleTestCase): ' - name: Linux\n' ' date: 1991\n' '...\n', conf) - conf = 'indentation: {spaces: 1, indent-sequences: yes}' + conf = 'indentation: {spaces: 1, indent-sequences: true}' self.check('---\n' 'object:\n' ' k1:\n' @@ -577,7 +577,7 @@ class IndentationTestCase(RuleTestCase): '...\n', conf) def test_two_spaces(self): - conf = 'indentation: {spaces: 2, indent-sequences: no}' + conf = 'indentation: {spaces: 2, indent-sequences: false}' self.check('---\n' 'object:\n' ' k1:\n' @@ -590,7 +590,7 @@ class IndentationTestCase(RuleTestCase): ' - name: Linux\n' ' date: 1991\n' '...\n', conf) - conf = 'indentation: {spaces: 2, indent-sequences: yes}' + conf = 'indentation: {spaces: 2, indent-sequences: true}' self.check('---\n' 'object:\n' ' k1:\n' @@ -605,7 +605,7 @@ class IndentationTestCase(RuleTestCase): '...\n', conf) def test_three_spaces(self): - conf = 'indentation: {spaces: 3, indent-sequences: no}' + conf = 'indentation: {spaces: 3, indent-sequences: false}' self.check('---\n' 'object:\n' ' k1:\n' @@ -618,7 +618,7 @@ class IndentationTestCase(RuleTestCase): ' - name: Linux\n' ' date: 1991\n' '...\n', conf) - conf = 'indentation: {spaces: 3, indent-sequences: yes}' + conf = 'indentation: {spaces: 3, indent-sequences: true}' self.check('---\n' 'object:\n' ' k1:\n' @@ -1130,7 +1130,7 @@ class IndentationTestCase(RuleTestCase): problem=(2, 3)) def test_multi_lines(self): - conf = 'indentation: {spaces: consistent, indent-sequences: yes}' + conf = 'indentation: {spaces: consistent, indent-sequences: true}' self.check('---\n' 'long_string: >\n' ' bla bla blah\n' @@ -1438,7 +1438,7 @@ class IndentationTestCase(RuleTestCase): '- !!map # Block collection\n' ' foo: bar\n', conf) - conf = 'indentation: {spaces: consistent, indent-sequences: no}' + conf = 'indentation: {spaces: consistent, indent-sequences: false}' self.check('---\n' 'sequence: !!seq\n' '- entry\n' @@ -1505,7 +1505,7 @@ class ScalarIndentationTestCase(RuleTestCase): def test_basics_plain(self): conf = ('indentation: {spaces: consistent,\n' - ' check-multi-line-strings: no}\n' + ' check-multi-line-strings: false}\n' 'document-start: disable\n') self.check('multi\n' 'line\n', conf) @@ -1534,7 +1534,7 @@ class ScalarIndentationTestCase(RuleTestCase): def test_check_multi_line_plain(self): conf = ('indentation: {spaces: consistent,\n' - ' check-multi-line-strings: yes}\n' + ' check-multi-line-strings: true}\n' 'document-start: disable\n') self.check('multi\n' ' line\n', conf, problem=(2, 2)) @@ -1557,7 +1557,7 @@ class ScalarIndentationTestCase(RuleTestCase): def test_basics_quoted(self): conf = ('indentation: {spaces: consistent,\n' - ' check-multi-line-strings: no}\n' + ' check-multi-line-strings: false}\n' 'document-start: disable\n') self.check('"multi\n' ' line"\n', conf) @@ -1588,7 +1588,7 @@ class ScalarIndentationTestCase(RuleTestCase): def test_check_multi_line_quoted(self): conf = ('indentation: {spaces: consistent,\n' - ' check-multi-line-strings: yes}\n' + ' check-multi-line-strings: true}\n' 'document-start: disable\n') self.check('"multi\n' 'line"\n', conf, problem=(2, 1)) @@ -1644,7 +1644,7 @@ class ScalarIndentationTestCase(RuleTestCase): def test_basics_folded_style(self): conf = ('indentation: {spaces: consistent,\n' - ' check-multi-line-strings: no}\n' + ' check-multi-line-strings: false}\n' 'document-start: disable\n') self.check('>\n' ' multi\n' @@ -1682,7 +1682,7 @@ class ScalarIndentationTestCase(RuleTestCase): def test_check_multi_line_folded_style(self): conf = ('indentation: {spaces: consistent,\n' - ' check-multi-line-strings: yes}\n' + ' check-multi-line-strings: true}\n' 'document-start: disable\n') self.check('>\n' ' multi\n' @@ -1723,7 +1723,7 @@ class ScalarIndentationTestCase(RuleTestCase): def test_basics_literal_style(self): conf = ('indentation: {spaces: consistent,\n' - ' check-multi-line-strings: no}\n' + ' check-multi-line-strings: false}\n' 'document-start: disable\n') self.check('|\n' ' multi\n' @@ -1761,7 +1761,7 @@ class ScalarIndentationTestCase(RuleTestCase): def test_check_multi_line_literal_style(self): conf = ('indentation: {spaces: consistent,\n' - ' check-multi-line-strings: yes}\n' + ' check-multi-line-strings: true}\n' 'document-start: disable\n') self.check('|\n' ' multi\n' @@ -1805,7 +1805,7 @@ class ScalarIndentationTestCase(RuleTestCase): def test_paragraph_plain(self): conf = ('indentation: {spaces: consistent,\n' - ' check-multi-line-strings: yes}\n' + ' check-multi-line-strings: true}\n' 'document-start: disable\n') self.check('- long text: very "long"\n' ' \'string\' with\n' @@ -1827,7 +1827,7 @@ class ScalarIndentationTestCase(RuleTestCase): def test_paragraph_double_quoted(self): conf = ('indentation: {spaces: consistent,\n' - ' check-multi-line-strings: yes}\n' + ' check-multi-line-strings: true}\n' 'document-start: disable\n') self.check('- long text: "very \\"long\\"\n' ' \'string\' with\n' @@ -1855,7 +1855,7 @@ class ScalarIndentationTestCase(RuleTestCase): def test_paragraph_single_quoted(self): conf = ('indentation: {spaces: consistent,\n' - ' check-multi-line-strings: yes}\n' + ' check-multi-line-strings: true}\n' 'document-start: disable\n') self.check('- long text: \'very "long"\n' ' \'\'string\'\' with\n' @@ -1883,7 +1883,7 @@ class ScalarIndentationTestCase(RuleTestCase): def test_paragraph_folded(self): conf = ('indentation: {spaces: consistent,\n' - ' check-multi-line-strings: yes}\n' + ' check-multi-line-strings: true}\n' 'document-start: disable\n') self.check('- long text: >\n' ' very "long"\n' @@ -1901,7 +1901,7 @@ class ScalarIndentationTestCase(RuleTestCase): def test_paragraph_literal(self): conf = ('indentation: {spaces: consistent,\n' - ' check-multi-line-strings: yes}\n' + ' check-multi-line-strings: true}\n' 'document-start: disable\n') self.check('- long text: |\n' ' very "long"\n' @@ -1919,7 +1919,7 @@ class ScalarIndentationTestCase(RuleTestCase): def test_consistent(self): conf = ('indentation: {spaces: consistent,\n' - ' check-multi-line-strings: yes}\n' + ' check-multi-line-strings: true}\n' 'document-start: disable\n') self.check('multi\n' 'line\n', conf) diff --git a/tests/rules/test_line_length.py b/tests/rules/test_line_length.py index be1115e..cab3e18 100644 --- a/tests/rules/test_line_length.py +++ b/tests/rules/test_line_length.py @@ -66,7 +66,7 @@ class LineLengthTestCase(RuleTestCase): self.check('---\n' + 81 * ' ' + '\n', conf, problem=(2, 81)) def test_non_breakable_word(self): - conf = 'line-length: {max: 20, allow-non-breakable-words: yes}' + conf = 'line-length: {max: 20, allow-non-breakable-words: true}' self.check('---\n' + 30 * 'A' + '\n', conf) self.check('---\n' 'this:\n' @@ -91,7 +91,7 @@ class LineLengthTestCase(RuleTestCase): 'long_line: http://localhost/very/very/long/url\n', conf, problem=(2, 21)) - conf = 'line-length: {max: 20, allow-non-breakable-words: no}' + conf = 'line-length: {max: 20, allow-non-breakable-words: false}' self.check('---\n' + 30 * 'A' + '\n', conf, problem=(2, 21)) self.check('---\n' 'this:\n' @@ -116,7 +116,7 @@ class LineLengthTestCase(RuleTestCase): 'long_line: http://localhost/very/very/long/url\n' '...\n', conf, problem=(2, 21)) - conf = ('line-length: {max: 20, allow-non-breakable-words: yes}\n' + conf = ('line-length: {max: 20, allow-non-breakable-words: true}\n' 'trailing-spaces: disable') self.check('---\n' 'loooooooooong+word+and+some+space+at+the+end \n', @@ -124,7 +124,7 @@ class LineLengthTestCase(RuleTestCase): def test_non_breakable_inline_mappings(self): conf = 'line-length: {max: 20, ' \ - 'allow-non-breakable-inline-mappings: yes}' + 'allow-non-breakable-inline-mappings: true}' self.check('---\n' 'long_line: http://localhost/very/very/long/url\n' 'long line: http://localhost/very/very/long/url\n', conf) @@ -137,7 +137,7 @@ class LineLengthTestCase(RuleTestCase): conf, problem1=(2, 21), problem2=(3, 21)) conf = ('line-length: {max: 20,' - ' allow-non-breakable-inline-mappings: yes}\n' + ' allow-non-breakable-inline-mappings: true}\n' 'trailing-spaces: disable') self.check('---\n' 'long_line: and+some+space+at+the+end \n', @@ -150,7 +150,7 @@ class LineLengthTestCase(RuleTestCase): conf, problem=(2, 21)) # See https://github.com/adrienverge/yamllint/issues/21 - conf = 'line-length: {allow-non-breakable-inline-mappings: yes}' + conf = 'line-length: {allow-non-breakable-inline-mappings: true}' self.check('---\n' 'content: |\n' ' {% this line is' + 99 * ' really' + ' long %}\n', diff --git a/tests/test_config.py b/tests/test_config.py index ef93ec7..5f06ef1 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -62,6 +62,45 @@ class SimpleConfigTestCase(unittest.TestCase): ' max-spaces-after: 1\n' ' abcdef: yes\n') + def test_yes_no_for_booleans(self): + c = config.YamlLintConfig('rules:\n' + ' indentation:\n' + ' spaces: 2\n' + ' indent-sequences: true\n' + ' check-multi-line-strings: false\n') + self.assertEqual(c.rules['indentation']['indent-sequences'], True) + self.assertEqual(c.rules['indentation']['check-multi-line-strings'], + False) + + c = config.YamlLintConfig('rules:\n' + ' indentation:\n' + ' spaces: 2\n' + ' indent-sequences: yes\n' + ' check-multi-line-strings: false\n') + self.assertEqual(c.rules['indentation']['indent-sequences'], True) + self.assertEqual(c.rules['indentation']['check-multi-line-strings'], + False) + + c = config.YamlLintConfig('rules:\n' + ' indentation:\n' + ' spaces: 2\n' + ' indent-sequences: whatever\n' + ' check-multi-line-strings: false\n') + self.assertEqual(c.rules['indentation']['indent-sequences'], + 'whatever') + self.assertEqual(c.rules['indentation']['check-multi-line-strings'], + False) + + with self.assertRaisesRegexp( + config.YamlLintConfigError, + 'invalid config: option "indent-sequences" of "indentation" ' + 'should be in '): + c = config.YamlLintConfig('rules:\n' + ' indentation:\n' + ' spaces: 2\n' + ' indent-sequences: YES!\n' + ' check-multi-line-strings: false\n') + def test_validate_rule_conf(self): class Rule(object): ID = 'fake' diff --git a/tests/test_spec_examples.py b/tests/test_spec_examples.py index cdc2bdb..f3e9239 100644 --- a/tests/test_spec_examples.py +++ b/tests/test_spec_examples.py @@ -67,7 +67,7 @@ conf_overrides = { 'example-2.18': ('empty-lines: {max-end: 1}\n'), 'example-2.19': ('empty-lines: {max-end: 1}\n'), 'example-2.28': ('empty-lines: {max-end: 3}\n'), - 'example-5.3': ('indentation: {indent-sequences: no}\n' + 'example-5.3': ('indentation: {indent-sequences: false}\n' 'colons: {max-spaces-before: 1}\n'), 'example-6.4': ('trailing-spaces: disable\n'), 'example-6.5': ('trailing-spaces: disable\n'), @@ -115,11 +115,11 @@ conf_overrides = { 'example-8.14': ('colons: {max-spaces-before: 1}\n'), 'example-8.16': ('indentation: {spaces: 1}\n'), 'example-8.17': ('indentation: disable\n'), - 'example-8.20': ('indentation: {indent-sequences: no}\n' + 'example-8.20': ('indentation: {indent-sequences: false}\n' 'colons: {max-spaces-before: 1}\n'), 'example-8.22': ('indentation: disable\n'), 'example-10.1': ('colons: {max-spaces-before: 2}\n'), - 'example-10.2': ('indentation: {indent-sequences: no}\n'), + 'example-10.2': ('indentation: {indent-sequences: false}\n'), 'example-10.8': ('truthy: disable\n'), 'example-10.9': ('truthy: disable\n'), } diff --git a/yamllint/conf/default.yaml b/yamllint/conf/default.yaml index e4d720b..0a22e81 100644 --- a/yamllint/conf/default.yaml +++ b/yamllint/conf/default.yaml @@ -16,14 +16,14 @@ rules: max-spaces-after: 1 comments: level: warning - require-starting-space: yes + require-starting-space: true min-spaces-from-content: 2 comments-indentation: level: warning document-end: disable document-start: level: warning - present: yes + present: true empty-lines: max: 2 max-start: 0 @@ -32,13 +32,13 @@ rules: max-spaces-after: 1 indentation: spaces: consistent - indent-sequences: yes - check-multi-line-strings: no + indent-sequences: true + check-multi-line-strings: false key-duplicates: enable line-length: max: 80 - allow-non-breakable-words: yes - allow-non-breakable-inline-mappings: no + allow-non-breakable-words: true + allow-non-breakable-inline-mappings: false new-line-at-end-of-file: enable new-lines: type: unix diff --git a/yamllint/conf/relaxed.yaml b/yamllint/conf/relaxed.yaml index fb2cdaf..83f5340 100644 --- a/yamllint/conf/relaxed.yaml +++ b/yamllint/conf/relaxed.yaml @@ -25,5 +25,5 @@ rules: indent-sequences: consistent line-length: level: warning - allow-non-breakable-inline-mappings: yes + allow-non-breakable-inline-mappings: true truthy: disable diff --git a/yamllint/rules/comments.py b/yamllint/rules/comments.py index 33fbcbe..69da045 100644 --- a/yamllint/rules/comments.py +++ b/yamllint/rules/comments.py @@ -20,14 +20,14 @@ Use this rule to control the position and formatting of comments. .. rubric:: Options * Use ``require-starting-space`` to require a space character right after the - ``#``. Set to ``yes`` to enable, ``no`` to disable. + ``#``. Set to ``true`` to enable, ``false`` to disable. * ``min-spaces-from-content`` is used to visually separate inline comments from content. It defines the minimal required number of spaces between a comment and its preceding content. .. rubric:: Examples -#. With ``comments: {require-starting-space: yes}`` +#. With ``comments: {require-starting-space: true}`` the following code snippet would **PASS**: :: diff --git a/yamllint/rules/document_end.py b/yamllint/rules/document_end.py index c6e7356..34323e4 100644 --- a/yamllint/rules/document_end.py +++ b/yamllint/rules/document_end.py @@ -19,12 +19,12 @@ Use this rule to require or forbid the use of document end marker (``...``). .. rubric:: Options -* Set ``present`` to ``yes`` when the document end marker is required, or to - ``no`` when it is forbidden. +* Set ``present`` to ``true`` when the document end marker is required, or to + ``false`` when it is forbidden. .. rubric:: Examples -#. With ``document-end: {present: yes}`` +#. With ``document-end: {present: true}`` the following code snippet would **PASS**: :: @@ -49,7 +49,7 @@ Use this rule to require or forbid the use of document end marker (``...``). - is: another one ... -#. With ``document-end: {present: no}`` +#. With ``document-end: {present: false}`` the following code snippet would **PASS**: :: diff --git a/yamllint/rules/document_start.py b/yamllint/rules/document_start.py index 5955a7f..090260a 100644 --- a/yamllint/rules/document_start.py +++ b/yamllint/rules/document_start.py @@ -19,12 +19,12 @@ Use this rule to require or forbid the use of document start marker (``---``). .. rubric:: Options -* Set ``present`` to ``yes`` when the document start marker is required, or to - ``no`` when it is forbidden. +* Set ``present`` to ``true`` when the document start marker is required, or to + ``false`` when it is forbidden. .. rubric:: Examples -#. With ``document-start: {present: yes}`` +#. With ``document-start: {present: true}`` the following code snippet would **PASS**: :: @@ -45,7 +45,7 @@ Use this rule to require or forbid the use of document start marker (``---``). - this - is: another one -#. With ``document-start: {present: no}`` +#. With ``document-start: {present: false}`` the following code snippet would **PASS**: :: diff --git a/yamllint/rules/indentation.py b/yamllint/rules/indentation.py index 9388e4f..db62f38 100644 --- a/yamllint/rules/indentation.py +++ b/yamllint/rules/indentation.py @@ -25,12 +25,12 @@ Use this rule to control the indentation. same within the file. * ``indent-sequences`` defines whether block sequences should be indented or not (when in a mapping, this indentation is not mandatory -- some people - perceive the ``-`` as part of the indentation). Possible values: ``yes``, - ``no``, ``whatever`` and ``consistent``. ``consistent`` requires either all - block sequences to be indented, or none to be. ``whatever`` means either + perceive the ``-`` as part of the indentation). Possible values: ``true``, + ``false``, ``whatever`` and ``consistent``. ``consistent`` requires either + all block sequences to be indented, or none to be. ``whatever`` means either indenting or not indenting individual block sequences is OK. * ``check-multi-line-strings`` defines whether to lint indentation in - multi-line strings. Set to ``yes`` to enable, ``no`` to disable. + multi-line strings. Set to ``true`` to enable, ``false`` to disable. .. rubric:: Examples @@ -99,7 +99,7 @@ Use this rule to control the indentation. Russian: dolls -#. With ``indentation: {spaces: 2, indent-sequences: no}`` +#. With ``indentation: {spaces: 2, indent-sequences: false}`` the following code snippet would **PASS**: :: @@ -152,7 +152,7 @@ Use this rule to control the indentation. - spaghetti - sauce -#. With ``indentation: {spaces: 4, check-multi-line-strings: yes}`` +#. With ``indentation: {spaces: 4, check-multi-line-strings: true}`` the following code snippet would **PASS**: :: diff --git a/yamllint/rules/line_length.py b/yamllint/rules/line_length.py index a0c0b37..e87972e 100644 --- a/yamllint/rules/line_length.py +++ b/yamllint/rules/line_length.py @@ -22,7 +22,7 @@ Use this rule to set a limit to lines length. * ``max`` defines the maximal (inclusive) length of lines. * ``allow-non-breakable-words`` is used to allow non breakable words (without spaces inside) to overflow the limit. This is useful for long URLs, for - instance. Use ``yes`` to allow, ``no`` to forbid. + instance. Use ``true`` to allow, ``false`` to forbid. * ``allow-non-breakable-inline-mappings`` implies ``allow-non-breakable-words`` and extends it to also allow non-breakable words in inline mappings. @@ -44,7 +44,7 @@ Use this rule to set a limit to lines length. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. -#. With ``line-length: {max: 60, allow-non-breakable-words: yes}`` +#. With ``line-length: {max: 60, allow-non-breakable-words: true}`` the following code snippet would **PASS**: :: @@ -68,15 +68,15 @@ Use this rule to set a limit to lines length. - foobar: http://localhost/very/very/very/very/very/very/very/very/long/url -#. With ``line-length: {max: 60, allow-non-breakable-words: yes, - allow-non-breakable-inline-mappings: yes}`` +#. With ``line-length: {max: 60, allow-non-breakable-words: true, + allow-non-breakable-inline-mappings: true}`` the following code snippet would **PASS**: :: - foobar: http://localhost/very/very/very/very/very/very/very/very/long/url -#. With ``line-length: {max: 60, allow-non-breakable-words: no}`` +#. With ``line-length: {max: 60, allow-non-breakable-words: false}`` the following code snippet would **FAIL**: ::