Skip to content

Update docs to explain escape character not valid #7103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 2, 2022
Merged

Update docs to explain escape character not valid #7103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cfa4696
Update docs to explain escape character not valid
tbennett0 Jul 2, 2022
bf667ae
autoupgrade doc
Pierre-Sassoulas Jul 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/user_guide/configuration/all-options.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:** ``[]``

Expand Down
3 changes: 2 additions & 1 deletion pylint/lint/base_options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
},
),
(
Expand Down