]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
Remove almost all unpaired backticks in docstrings (#119231)
authorGeoffrey Thomas <geofft@ldpreload.com>
Wed, 22 May 2024 16:35:18 +0000 (12:35 -0400)
committerGitHub <noreply@github.com>
Wed, 22 May 2024 16:35:18 +0000 (12:35 -0400)
commitef172521a9e9dfadebe57d590bfb53a0e9ac3a0b
tree22da7f25285e842c48daf81b0ae2a57e223cc674
parent81865002aee8eaaeb3c7e402f86183afa6de77bf
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.
39 files changed:
Lib/_pyrepl/keymap.py
Lib/_pyrepl/reader.py
Lib/cmd.py
Lib/configparser.py
Lib/doctest.py
Lib/email/_parseaddr.py
Lib/email/_policybase.py
Lib/email/base64mime.py
Lib/email/charset.py
Lib/email/generator.py
Lib/email/header.py
Lib/email/iterators.py
Lib/email/message.py
Lib/email/mime/multipart.py
Lib/email/parser.py
Lib/email/quoprimime.py
Lib/ftplib.py
Lib/getopt.py
Lib/heapq.py
Lib/http/client.py
Lib/http/cookiejar.py
Lib/imaplib.py
Lib/mimetypes.py
Lib/smtplib.py
Lib/tarfile.py
Lib/test/support/smtpd.py
Lib/test/test_asyncio/test_locks.py
Lib/trace.py
Lib/unittest/mock.py
Lib/wsgiref/headers.py
Lib/zipfile/__init__.py
Modules/_heapqmodule.c
Modules/_interpretersmodule.c
Modules/cjkcodecs/clinic/multibytecodec.c.h
Modules/cjkcodecs/multibytecodec.c
Modules/clinic/pyexpat.c.h
Modules/pyexpat.c
Objects/bytesobject.c
Objects/odictobject.c