Skip to content

Commit 47a4e94

Browse files
authored
docs: properly escape backslashes (#10736)
This should fix most cases except the autogenerated docs.
1 parent 7f7f7b8 commit 47a4e94

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

doc/faq.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ localized using the following rules:
135135
* "pylint" subdirectory of the user's XDG_CACHE_HOME if the environment variable is set, otherwise
136136
- Linux: "~/.cache/pylint"
137137
- macOS: "~/Library/Caches/pylint"
138-
- Windows: "C:\Users\<username>\AppData\Local\pylint"
138+
- Windows: "C:\\Users\\<username>\\AppData\\Local\\pylint"
139139
* ".pylint.d" directory in the current directory
140140

141141
How does the website pylint dot org relate to this project?

doc/whatsnew/0/0.x.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Release date: 2013-02-26
5454
* #113231: logging checker now looks at instances of Logger classes
5555
in addition to the base logging module. (patch by Mike Bryant)
5656

57-
* #111799: don't warn about octal escape sequence, but warn about \o
57+
* #111799: don't warn about octal escape sequence, but warn about ``\o``
5858
which is not octal in Python (patch by Martin Pool)
5959

6060
* #110839: bind <F5> to Run button in pylint-gui
@@ -940,7 +940,7 @@ Release date: 2005-02-16
940940
* fix false positive on W0706 ("identifier used to raise an exception
941941
assigned to...")
942942

943-
* fix interpretation of "\t" as value for the indent-string
943+
* fix interpretation of ``\t`` as value for the indent-string
944944
configuration variable
945945

946946
* fix --rcfile so that --rcfile=pylintrc (only --rcfile pylintrc was

doc/whatsnew/1/1.2.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Release date: 2014-04-30
1919

2020
Closes BitBucket #176
2121

22-
* Do not warn about \u escapes in string literals when Unicode literals
22+
* Do not warn about ``\u`` escapes in string literals when Unicode literals
2323
are used for Python 2.*.
2424

2525
Closes BitBucket #151

doc/whatsnew/2/2.12/full.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Release date: 2021-11-25
1313

1414
Closes #5342
1515

16-
* Specified that the ``ignore-paths`` option considers "\" to represent a
16+
* Specified that the ``ignore-paths`` option considers ``\`` to represent a
1717
windows directory delimiter instead of a regular expression escape
1818
character.
1919

@@ -23,7 +23,7 @@ Release date: 2021-11-25
2323
Closes #5437
2424

2525
* Fixed handling of Sphinx-style parameter docstrings with asterisks. These
26-
should be escaped with by prepending a "\".
26+
should be escaped with by prepending a ``\``.
2727

2828
Closes #5406
2929

0 commit comments

Comments
 (0)