diff --git a/doc/user_guide/configuration/all-options.rst b/doc/user_guide/configuration/all-options.rst index 6aa057ccaf..f6f8bdf293 100644 --- a/doc/user_guide/configuration/all-options.rst +++ b/doc/user_guide/configuration/all-options.rst @@ -99,7 +99,7 @@ Standard Checkers --ignore-paths """""""""""""" -*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.* +*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.* **Default:** ``[]`` diff --git a/pylint/lint/base_options.py b/pylint/lint/base_options.py index d909e39c59..3ee0d5238f 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.", }, ), (