[Python-checkins] bpo-39616: clarify SSLContext.check_hostname effect (GH-18484)

[miss-islington]

https://github.com/python/cpython/commit/9798cef92b882cd82a338d3368eaf3c4a32f5c2d
commit: 9798cef92b882cd82a338d3368eaf3c4a32f5c2d
branch: master
author: Ville Skyttä <ville.skytta at iki.fi>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2021-03-27T07:20:11-07:00
summary:

bpo-39616: clarify SSLContext.check_hostname effect (GH-18484)



It doesn't actually affect whether match_hostname() is called (it
never is in this context any longer), but whether hostname
verification occurs in the first place.

files:
M Doc/library/ssl.rst

diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst
index 1adac843f4eec..c0789ee5cfc0e 100644
--- a/Doc/library/ssl.rst
+++ b/Doc/library/ssl.rst
@@ -1885,7 +1885,7 @@ to speed up repeated connections from the same clients.
 
 .. attribute:: SSLContext.check_hostname
 
-   Whether to match the peer cert's hostname with :func:`match_hostname` in
+   Whether to match the peer cert's hostname in
    :meth:`SSLSocket.do_handshake`. The context's
    :attr:`~SSLContext.verify_mode` must be set to :data:`CERT_OPTIONAL` or
    :data:`CERT_REQUIRED`, and you must pass *server_hostname* to