From: Yury Selivanov Date: Mon, 29 Jan 2018 04:51:08 +0000 (-0500) Subject: bpo-32251: Fix docs (#5408) X-Git-Tag: v3.7.0b1~41 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=07627e9a6a5f418354ff3dc99a0f36bc5b79dcd8;p=python bpo-32251: Fix docs (#5408) --- diff --git a/Doc/library/asyncio-protocol.rst b/Doc/library/asyncio-protocol.rst index a08c4d379b..004cac80d9 100644 --- a/Doc/library/asyncio-protocol.rst +++ b/Doc/library/asyncio-protocol.rst @@ -451,7 +451,7 @@ Streaming protocols with manual receive buffer control .. versionadded:: 3.7 **Important:** :class:`BufferedProtocol` has been been added to - asyncio in Python 3.7 *on a provisional basis*! Treat it as an + asyncio in Python 3.7 *on a provisional basis*! Consider it as an experimental API that might be changed or removed in Python 3.8. @@ -487,7 +487,8 @@ instances: :meth:`get_buffer` can be called an arbitrary number of times during a connection. However, :meth:`eof_received` is called at most once -and, if called, :meth:`data_received` won't be called after it. +and, if called, :meth:`get_buffer` and :meth:`buffer_updated` +won't be called after it. State machine: diff --git a/Lib/asyncio/protocols.py b/Lib/asyncio/protocols.py index 9e786dcfbb..8904478f1a 100644 --- a/Lib/asyncio/protocols.py +++ b/Lib/asyncio/protocols.py @@ -106,7 +106,7 @@ class BufferedProtocol(BaseProtocol): """Interface for stream protocol with manual buffer control. Important: this has been been added to asyncio in Python 3.7 - *on a provisional basis*! Treat it as an experimental API that + *on a provisional basis*! Consider it as an experimental API that might be changed or removed in Python 3.8. Event methods, such as `create_server` and `create_connection`,