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/http | |
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/http')
-rw-r--r-- | Lib/http/client.py | 10 | ||||
-rw-r--r-- | Lib/http/cookiejar.py | 2 |
2 files changed, 6 insertions, 6 deletions
diff --git a/Lib/http/client.py b/Lib/http/client.py index a353716..fab90a0 100644 --- a/Lib/http/client.py +++ b/Lib/http/client.py @@ -1025,7 +1025,7 @@ class HTTPConnection: response.close() def send(self, data): - """Send `data' to the server. + """Send 'data' to the server. ``data`` can be a string object, a bytes object, an array object, a file-like object that supports a .read() method, or an iterable object. """ @@ -1137,10 +1137,10 @@ class HTTPConnection: skip_accept_encoding=False): """Send a request to the server. - `method' specifies an HTTP request method, e.g. 'GET'. - `url' specifies the object being requested, e.g. '/index.html'. - `skip_host' if True does not add automatically a 'Host:' header - `skip_accept_encoding' if True does not add automatically an + 'method' specifies an HTTP request method, e.g. 'GET'. + 'url' specifies the object being requested, e.g. '/index.html'. + 'skip_host' if True does not add automatically a 'Host:' header + 'skip_accept_encoding' if True does not add automatically an 'Accept-Encoding:' header """ diff --git a/Lib/http/cookiejar.py b/Lib/http/cookiejar.py index bd89370..fb0fd2e 100644 --- a/Lib/http/cookiejar.py +++ b/Lib/http/cookiejar.py @@ -1986,7 +1986,7 @@ class MozillaCookieJar(FileCookieJar): This class differs from CookieJar only in the format it uses to save and load cookies to and from a file. This class uses the Mozilla/Netscape - `cookies.txt' format. curl and lynx use this file format, too. + 'cookies.txt' format. curl and lynx use this file format, too. Don't expect cookies saved while the browser is running to be noticed by the browser (in fact, Mozilla on unix will overwrite your saved cookies if |