summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBernhard Wagner <github.comNotification20120125@xmlizer.net>2023-03-29 19:21:56 (GMT)
committerGitHub <noreply@github.com>2023-03-29 19:21:56 (GMT)
commitd052a383f1a0c599c176a12c73a761ca00436d8b (patch)
treeed46a21709c55e9cdd78b532a3f29e61cfa788fa
parente375bff03736f809fbc234010c087ef9d7e0d384 (diff)
downloadcpython-d052a383f1a0c599c176a12c73a761ca00436d8b.zip
cpython-d052a383f1a0c599c176a12c73a761ca00436d8b.tar.gz
cpython-d052a383f1a0c599c176a12c73a761ca00436d8b.tar.bz2
gh-103112: Add http.client.HTTPResponse.read docstring and fix pydoc output (#103113)
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> Co-authored-by: Éric <merwok@netwok.org>
-rw-r--r--Lib/http/client.py1
-rw-r--r--Misc/NEWS.d/next/Documentation/2023-03-29-14-51-39.gh-issue-103112.XgGSEO.rst1
2 files changed, 2 insertions, 0 deletions
diff --git a/Lib/http/client.py b/Lib/http/client.py
index 15c5cf6..bd55e7d 100644
--- a/Lib/http/client.py
+++ b/Lib/http/client.py
@@ -448,6 +448,7 @@ class HTTPResponse(io.BufferedIOBase):
return self.fp is None
def read(self, amt=None):
+ """Read and return the response body, or up to the next amt bytes."""
if self.fp is None:
return b""
diff --git a/Misc/NEWS.d/next/Documentation/2023-03-29-14-51-39.gh-issue-103112.XgGSEO.rst b/Misc/NEWS.d/next/Documentation/2023-03-29-14-51-39.gh-issue-103112.XgGSEO.rst
new file mode 100644
index 0000000..babc815
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2023-03-29-14-51-39.gh-issue-103112.XgGSEO.rst
@@ -0,0 +1 @@
+Add docstring to :meth:`http.client.HTTPResponse.read` to fix ``pydoc`` output.