From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Wed, 29 Mar 2023 22:30:03 +0000 (-0700)
Subject: [3.11] gh-103112: Add http.client.HTTPResponse.read docstring and fix pydoc output... 
X-Git-Tag: v3.11.3~9
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ae42c1d168a3672964ffbb248e419417812ad9c0;p=thirdparty%2FPython%2Fcpython.git

[3.11] gh-103112: Add http.client.HTTPResponse.read docstring and fix pydoc output (GH-103113) (#103119)

(cherry picked from commit d052a383f1a0c599c176a12c73a761ca00436d8b)

Co-authored-by: Bernhard Wagner <github.comNotification20120125@xmlizer.net>
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>
---

diff --git a/Lib/http/client.py b/Lib/http/client.py
index 4622a8f4297d..eabb0ca26940 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 000000000000..babc81509661
--- /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.