From cfa4696ef11d1be544a7ddb76c8b24d761aafb7a Mon Sep 17 00:00:00 2001 From: tbennett0 Date: Fri, 1 Jul 2022 22:59:36 -0600 Subject: [PATCH 1/2] Update docs to explain escape character not valid Adding note from #5415 to docs --- pylint/lint/base_options.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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.", }, ), ( From bf667ae56a39f4c94fc6cbf38c024ec563bba41f Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Sat, 2 Jul 2022 08:06:21 +0200 Subject: [PATCH 2/2] autoupgrade doc --- doc/user_guide/configuration/all-options.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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:** ``[]``