diff options
| author | Geoffrey Thomas <geofft@ldpreload.com> | 2024-05-22 16:35:18 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-22 16:35:18 (GMT) |
| commit | ef172521a9e9dfadebe57d590bfb53a0e9ac3a0b (patch) | |
| tree | 22da7f25285e842c48daf81b0ae2a57e223cc674 /Lib/email/quoprimime.py | |
| parent | 81865002aee8eaaeb3c7e402f86183afa6de77bf (diff) | |
| download | cpython-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/quoprimime.py')
| -rw-r--r-- | Lib/email/quoprimime.py | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Lib/email/quoprimime.py b/Lib/email/quoprimime.py index 27fcbb5..500bbc5 100644 --- a/Lib/email/quoprimime.py +++ b/Lib/email/quoprimime.py @@ -5,7 +5,7 @@ """Quoted-printable content transfer encoding per RFCs 2045-2047. This module handles the content transfer encoding method defined in RFC 2045 -to encode US ASCII-like 8-bit data called `quoted-printable'. It is used to +to encode US ASCII-like 8-bit data called 'quoted-printable'. It is used to safely encode text that is in a character set similar to the 7-bit US ASCII character set, but that includes some 8-bit characters that are normally not allowed in email bodies or headers. @@ -17,7 +17,7 @@ This module provides an interface to encode and decode both headers and bodies with quoted-printable 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 @@ -127,7 +127,7 @@ def quote(c): def header_encode(header_bytes, charset='iso-8859-1'): """Encode a single header line with quoted-printable (like) encoding. - Defined in RFC 2045, this `Q' encoding is similar to quoted-printable, but + Defined in RFC 2045, this 'Q' encoding is similar to quoted-printable, but used specifically for email header fields to allow charsets with mostly 7 bit characters (and some 8 bit) to remain more or less readable in non-RFC 2045 aware mail clients. @@ -290,7 +290,7 @@ def _unquote_match(match): # Header decoding is done a bit differently def header_decode(s): - """Decode a string encoded with RFC 2045 MIME header `Q' encoding. + """Decode a string encoded with RFC 2045 MIME header 'Q' encoding. This function does not parse a full MIME header value encoded with quoted-printable (like =?iso-8859-1?q?Hello_World?=) -- please use |