summaryrefslogtreecommitdiffstats
path: root/Lib/email/base64mime.py
diff options
context:
space:
mode:
authorGeoffrey Thomas <geofft@ldpreload.com>2024-05-22 16:35:18 (GMT)
committerGitHub <noreply@github.com>2024-05-22 16:35:18 (GMT)
commitef172521a9e9dfadebe57d590bfb53a0e9ac3a0b (patch)
tree22da7f25285e842c48daf81b0ae2a57e223cc674 /Lib/email/base64mime.py
parent81865002aee8eaaeb3c7e402f86183afa6de77bf (diff)
downloadcpython-ef172521a9e9dfadebe57d590bfb53a0e9ac3a0b.zip
cpython-ef172521a9e9dfadebe57d590bfb53a0e9ac3a0b.tar.gz
cpython-ef172521a9e9dfadebe57d590bfb53a0e9ac3a0b.tar.bz2
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/base64mime.py')
-rw-r--r--Lib/email/base64mime.py2
1 files changed, 1 insertions, 1 deletions
diff --git a/Lib/email/base64mime.py b/Lib/email/base64mime.py
index 4cdf226..d440de9 100644
--- a/Lib/email/base64mime.py
+++ b/Lib/email/base64mime.py
@@ -15,7 +15,7 @@ This module provides an interface to encode and decode both headers and bodies
with Base64 encoding.
RFC 2045 defines a method for including character set information in an
-`encoded-word' in a header. This method is commonly used for 8-bit real names
+'encoded-word' in a header. This method is commonly used for 8-bit real names
in To:, From:, Cc:, etc. fields, as well as Subject: lines.
This module does not do the line wrapping or end-of-line character conversion