Skip to content

Commit 6acbe55

Browse files
authored
Add newline docs to README (#176)
1 parent c3177d7 commit 6acbe55

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,10 @@ load-plugins = [
3636
```
3737

3838
## Usage
39-
Add list of patterns and codes you would like to ignore.
39+
Add a list of patterns and codes you would like to ignore.
4040
The patterns are matched using [globs](https://docs.python.org/3/library/glob.html).
41-
41+
The config is parsed based on newlines, meaning each line should follow the pattern `<file-pattern>:<rule1>,<rule2>`.
42+
Newlines between rules are not supported.
4243

4344
> Prior to v2.0.0, `pylint-per-file-ignores` did not use globs but regex.
4445
> When migrating, please check your configuration carefully.
@@ -68,6 +69,16 @@ per-file-ignores = [
6869
]
6970
```
7071

72+
Please note, that for non-toml files newlines are important.
73+
For example, the following won't parse as expected
74+
75+
```ini
76+
[pylint.MESSAGES CONTROL]
77+
per-file-ignores =
78+
/folder_1/*:missing-function-docstring,
79+
missing-class-docstring
80+
```
81+
7182
## Development
7283
This project uses `uv`.
7384
To setup a venv for development use

0 commit comments

Comments
 (0)