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.
This commit is contained in:
Geoffrey Thomas 2024-05-22 12:35:18 -04:00 committed by GitHub
parent 81865002ae
commit ef172521a9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
39 changed files with 172 additions and 172 deletions

View file

@ -105,7 +105,7 @@ class SMTPSenderRefused(SMTPResponseException):
"""Sender address refused.
In addition to the attributes set by on all SMTPResponseException
exceptions, this sets `sender' to the string that the SMTP refused.
exceptions, this sets 'sender' to the string that the SMTP refused.
"""
def __init__(self, code, msg, sender):
@ -315,7 +315,7 @@ class SMTP:
def connect(self, host='localhost', port=0, source_address=None):
"""Connect to a host on a given port.
If the hostname ends with a colon (`:') followed by a number, and
If the hostname ends with a colon (':') followed by a number, and
there is no port specified, that suffix will be stripped off and the
number interpreted as the port number to use.
@ -346,7 +346,7 @@ class SMTP:
return (code, msg)
def send(self, s):
"""Send `s' to the server."""
"""Send 's' to the server."""
if self.debuglevel > 0:
self._print_debug('send:', repr(s))
if self.sock: