Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

linter: Add explanation for custom rule file delimitation operators.

This commit is contained in:
Robert Hönig 2017-09-11 19:48:19 +02:00 committed by Tim Abbott
parent e39197a9b7
commit 2248c7ac0d
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
tools/linter_lib/custom_check.py
View File

@ -103,6 +103,12 @@ def build_custom_checkers(by_lang):
return failed
# By default, a rule applies to all files within the extension for which it is specified (e.g. all .py files)
# There are three operators we can use to manually include or exclude files from linting for a rule:
# 'exclude': 'set([<path>, ...])' - if <path> is a filename, excludes that file.
# if <path> is a directory, excludes all files directly below the directory <path>.
# 'exclude_line': 'set([(<path>, <line>), ...])' - excludes all lines matching <line> in the file <path> from linting.
# 'include_only': 'set([<path>, ...])' - includes only those files where <path> is a substring of the filepath.
trailing_whitespace_rule = {
'pattern': '\s+$',
'strip': '\n',