aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/Lib/email/parser.py
diff options
context:
space:
mode:
authorGeoffrey Thomas <geofft@ldpreload.com>2024-05-22 12:35:18 -0400
committerGitHub <noreply@github.com>2024-05-22 12:35:18 -0400
commitef172521a9e9dfadebe57d590bfb53a0e9ac3a0b (patch)
tree22da7f25285e842c48daf81b0ae2a57e223cc674 /Lib/email/parser.py
parent81865002aee8eaaeb3c7e402f86183afa6de77bf (diff)
downloadcpython-ef172521a9e9dfadebe57d590bfb53a0e9ac3a0b.tar.gz
cpython-ef172521a9e9dfadebe57d590bfb53a0e9ac3a0b.zip
Remove almost all unpaired backticks in docstrings (#119231)
As reported in #117847 and #115366, an unpaired backtick in a docstring tends to confuse e.g. Sphinx running on subclasses of standard library objects, and the typographic style of using a backtick as an opening quote is no longer in favor. Convert almost all uses of the form The variable `foo' should do xyz to The variable 'foo' should do xyz and also fix up miscellaneous other unpaired backticks (extraneous / missing characters). No functional change is intended here other than in human-readable docstrings.
Diffstat (limited to 'Lib/email/parser.py')
-rw-r--r--Lib/email/parser.py4
1 files changed, 2 insertions, 2 deletions
diff --git a/Lib/email/parser.py b/Lib/email/parser.py
index 06d99b17f2f..475aa2b1a66 100644
--- a/Lib/email/parser.py
+++ b/Lib/email/parser.py
@@ -22,7 +22,7 @@ class Parser:
textual representation of the message.
The string must be formatted as a block of RFC 2822 headers and header
- continuation lines, optionally preceded by a `Unix-from' header. The
+ continuation lines, optionally preceded by a 'Unix-from' header. The
header block is terminated either by the end of the string or by a
blank line.
@@ -82,7 +82,7 @@ class BytesParser:
textual representation of the message.
The input must be formatted as a block of RFC 2822 headers and header
- continuation lines, optionally preceded by a `Unix-from' header. The
+ continuation lines, optionally preceded by a 'Unix-from' header. The
header block is terminated either by the end of the input or by a
blank line.