[Python-checkins] gh-92679: Clarify asyncio.loop.start_tls parameters (GH-92682)

[miss-islington]

https://github.com/python/cpython/commit/46ccb35a400b1abe8c29ad2d7f17295610d768c7
commit: 46ccb35a400b1abe8c29ad2d7f17295610d768c7
branch: 3.11
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-11-01T22:12:52-07:00
summary:

gh-92679: Clarify asyncio.loop.start_tls parameters (GH-92682)

(cherry picked from commit 898d0d9ad8328326ba5f7df9952e9dc287766ca3)

Co-authored-by: Oleg Iarygin <oleg at arhadthedev.net>

files:
M Doc/library/asyncio-eventloop.rst

diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst
index 93bca96fff6f..cf9b3b7ce079 100644
--- a/Doc/library/asyncio-eventloop.rst
+++ b/Doc/library/asyncio-eventloop.rst
@@ -856,9 +856,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: