Skip to content

Commit c2c2f51

Browse files
Update docs to explain escape character not valid (#7103)
Adding note from #5415 to docs Co-authored-by: Pierre Sassoulas <[email protected]>
1 parent 6e51b47 commit c2c2f51

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

doc/user_guide/configuration/all-options.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Standard Checkers
9999

100100
--ignore-paths
101101
""""""""""""""
102-
*Add files or directories matching the regex patterns to the ignore-list. The regex matches against paths and can be in Posix or Windows format.*
102+
*Add files or directories matching the regex patterns to the ignore-list. The regex matches against paths and can be in Posix or Windows format. Because '\' represents the directory delimiter on Windows systems, it can't be used as an escape character.*
103103

104104
**Default:** ``[]``
105105

pylint/lint/base_options.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,8 @@ def _make_linter_options(linter: PyLinter) -> Options:
6969
"default": [],
7070
"help": "Add files or directories matching the regex patterns to the "
7171
"ignore-list. The regex matches against paths and can be in "
72-
"Posix or Windows format.",
72+
"Posix or Windows format. Because '\\' represents the directory delimiter "
73+
"on Windows systems, it can't be used as an escape character.",
7374
},
7475
),
7576
(

0 commit comments

Comments
 (0)