Skip to content

Commit 7417ea4

Browse files
committed
Add newline docs to README
1 parent c3177d7 commit 7417ea4

1 file changed

Lines changed: 12 additions & 3 deletions

File tree

README.md

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

3838
## Usage
39-
Add list of patterns and codes you would like to ignore.
40-
The patterns are matched using [globs](https://docs.python.org/3/library/glob.html).
41-
39+
Add a list of patterns and codes you would like to ignore.
40+
The patterns are matched using [globs](https://docs.python.org/3/library/glob.html). The config is parsed used on newlines.
4241

4342
> Prior to v2.0.0, `pylint-per-file-ignores` did not use globs but regex.
4443
> When migrating, please check your configuration carefully.
@@ -68,6 +67,16 @@ per-file-ignores = [
6867
]
6968
```
7069

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

0 commit comments

Comments
 (0)