Skip to content

Commit c1f6d5d

Browse files
author
Sergey Vilgelm
committed
update README.md
1 parent 93c41c3 commit c1f6d5d

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ Generate a `.pylintrc` file by executing `pylint --generate-rcfile`.
2020
Then add `pylintfileheader` to the plugins to load and set the `file-header` option to the [regular expression](https://docs.python.org/3/library/re.html#regular-expression-syntax) that the file header should match.
2121
When the `file-header` setting is omitted, pylint will pass.
2222

23+
### Options
24+
25+
* `file-header` is a regexp representing the file header that should be on top of a file.
26+
* `file-header-path` is the path to the file that contains the header. This is useful in case of long, multi-line headers, such as copyrights.
2327
* `file-header-ignore-empty-files` turns on the mode of ignoring the empty files, like `__init__.py`. The default value is `False`.
2428

2529
## Example

0 commit comments

Comments
 (0)