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

feat(comments): Allow comments with multiple hash chars

Browse Source 
This change make the `comments` rule accept comments that start with
multiple pound signs, e.g.:

    ##############################
    ## This is some documentation

Closes: #12
This commit is contained in:
Adrien Vergé
2016-08-12 11:58:57 +02:00
parent 82dd7dbf16
commit 5b98cd2053
2 changed files with 46 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
yamllint/rules/comments.py
View File

@@ -35,6 +35,12 @@ Use this rule to control the position and formatting of comments.
# This sentence
# is a block comment
the following code snippet would **PASS**:
::
##############################
## This is some documentation
the following code snippet would **FAIL**:
::
@@ -71,9 +77,13 @@ def check(conf, comment):
yield LintProblem(comment.line_no, comment.column_no,
'too few spaces before comment')
if (conf['require-starting-space'] and
comment.pointer + 1 < len(comment.buffer) and
comment.buffer[comment.pointer + 1] != ' ' and
comment.buffer[comment.pointer + 1] != '\n'):
yield LintProblem(comment.line_no, comment.column_no + 1,
'missing starting space in comment')
if conf['require-starting-space']:
text_start = comment.pointer + 1
while (comment.buffer[text_start] == '#' and
text_start < len(comment.buffer)):
text_start += 1
if (text_start < len(comment.buffer) and
comment.buffer[text_start] not in (' ', '\n', '\0')):
yield LintProblem(comment.line_no,
comment.column_no + text_start - comment.pointer,
'missing starting space in comment')