summaryrefslogtreecommitdiff
path: root/pylint/lint
diff options
context:
space:
mode:
authortbennett0 <tbennett0@users.noreply.github.com>2022-07-02 00:24:32 -0600
committerGitHub <noreply@github.com>2022-07-02 08:24:32 +0200
commitc2c2f51c35059302fe96311819bf7e3ff9ecfbe2 (patch)
tree8af5fb6ca52b8ff2a464c21710076b0e682d6b70 /pylint/lint
parent6e51b4767d77fbfd584a27c60caab21be3416ce2 (diff)
downloadpylint-git-c2c2f51c35059302fe96311819bf7e3ff9ecfbe2.tar.gz
Update docs to explain escape character not valid (#7103)
Adding note from #5415 to docs Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
Diffstat (limited to 'pylint/lint')
-rw-r--r--pylint/lint/base_options.py3
1 files changed, 2 insertions, 1 deletions
diff --git a/pylint/lint/base_options.py b/pylint/lint/base_options.py
index d909e39c5..3ee0d5238 100644
--- a/pylint/lint/base_options.py
+++ b/pylint/lint/base_options.py
@@ -69,7 +69,8 @@ def _make_linter_options(linter: PyLinter) -> Options:
"default": [],
"help": "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.",
+ "Posix or Windows format. Because '\\' represents the directory delimiter "
+ "on Windows systems, it can't be used as an escape character.",
},
),
(