diff options
author | Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> | 2024-01-14 21:14:08 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-01-14 21:14:08 (GMT) |
commit | cc11c76da7a099bb4535ab8ca507e55263fc35b6 (patch) | |
tree | 82c542a9a7784af1ccf823fc40e6841cb03de1bc /Doc/library/http.client.rst | |
parent | 2aea0e967a28aa1dc7729e28dd36dd9abf50e24b (diff) | |
download | cpython-cc11c76da7a099bb4535ab8ca507e55263fc35b6.zip cpython-cc11c76da7a099bb4535ab8ca507e55263fc35b6.tar.gz cpython-cc11c76da7a099bb4535ab8ca507e55263fc35b6.tar.bz2 |
[3.12] gh-101100: Fix Sphinx warnings in `howto/urllib2.rst` and `library/http.client.rst` (GH-114060) (#114063)
(cherry picked from commit c2808431b32fa7bc0d222d4549389f781f1a7333)
Diffstat (limited to 'Doc/library/http.client.rst')
-rw-r--r-- | Doc/library/http.client.rst | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/Doc/library/http.client.rst b/Doc/library/http.client.rst index c46314f..95b6c1f 100644 --- a/Doc/library/http.client.rst +++ b/Doc/library/http.client.rst @@ -92,7 +92,7 @@ The module provides the following classes: .. versionchanged:: 3.4.3 This class now performs all the necessary certificate and hostname checks by default. To revert to the previous, unverified, behavior - :func:`ssl._create_unverified_context` can be passed to the *context* + :func:`!ssl._create_unverified_context` can be passed to the *context* parameter. .. versionchanged:: 3.8 @@ -103,7 +103,7 @@ The module provides the following classes: .. versionchanged:: 3.10 This class now sends an ALPN extension with protocol indicator ``http/1.1`` when no *context* is given. Custom *context* should set - ALPN protocols with :meth:`~ssl.SSLContext.set_alpn_protocol`. + ALPN protocols with :meth:`~ssl.SSLContext.set_alpn_protocols`. .. versionchanged:: 3.12 The deprecated *key_file*, *cert_file* and *check_hostname* parameters @@ -124,7 +124,7 @@ This module provides the following function: .. function:: parse_headers(fp) Parse the headers from a file pointer *fp* representing a HTTP - request/response. The file has to be a :class:`BufferedIOBase` reader + request/response. The file has to be a :class:`~io.BufferedIOBase` reader (i.e. not text) and must provide a valid :rfc:`2822` style header. This function returns an instance of :class:`http.client.HTTPMessage` @@ -416,7 +416,7 @@ HTTPConnection Objects .. versionadded:: 3.7 -As an alternative to using the :meth:`request` method described above, you can +As an alternative to using the :meth:`~HTTPConnection.request` method described above, you can also send your request step by step, by using the four functions below. @@ -648,6 +648,8 @@ method attribute. Here is an example session that uses the ``PUT`` method:: HTTPMessage Objects ------------------- +.. class:: HTTPMessage(email.message.Message) + An :class:`http.client.HTTPMessage` instance holds the headers from an HTTP response. It is implemented using the :class:`email.message.Message` class. |