]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-92679: Clarify asyncio.loop.start_tls parameters (#92682)
authorOleg Iarygin <oleg@arhadthedev.net>
Wed, 2 Nov 2022 04:52:19 +0000 (08:52 +0400)
committerGitHub <noreply@github.com>
Wed, 2 Nov 2022 04:52:19 +0000 (21:52 -0700)
Doc/library/asyncio-eventloop.rst

index 4f12074dd7009823657e4e737052d929d54b129a..d0a1ed2b99e55d1b23e5a17403894adbb75c2cc5 100644 (file)
@@ -877,9 +877,14 @@ TLS Upgrade
 
    Upgrade an existing transport-based connection to TLS.
 
-   Return a new transport instance, that the *protocol* must start using
-   immediately after the *await*.  The *transport* instance passed to
-   the *start_tls* method should never be used again.
+   Create a TLS coder/decoder instance and insert it between the *transport*
+   and the *protocol*. The coder/decoder implements both *transport*-facing
+   protocol and *protocol*-facing transport.
+
+   Return the created two-interface instance. After *await*, the *protocol*
+   must stop using the original *transport* and communicate with the returned
+   object only because the coder caches *protocol*-side data and sporadically
+   exchanges extra TLS session packets with *transport*.
 
    Parameters: