From: Kojo Idrissa Date: Sun, 2 Jul 2017 02:48:07 +0000 (+0900) Subject: [3.6] bpo-29933: Improve set_write_buffer_limits description (GH-2262) (GH-2532) X-Git-Tag: v3.6.3rc1~274 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=03af4282423b1c287a194664f90496cfc9cf20c7;p=python [3.6] bpo-29933: Improve set_write_buffer_limits description (GH-2262) (GH-2532) Improve the description of the high and low parameters for set_write_buffer_limits. Also fixed a small grammatical issue. (cherry picked from commit 5200a7c7f9ea65a96330c5f276f4acc6ec70854e) --- diff --git a/Doc/library/asyncio-protocol.rst b/Doc/library/asyncio-protocol.rst index 3f55506c66..dfe37c239d 100644 --- a/Doc/library/asyncio-protocol.rst +++ b/Doc/library/asyncio-protocol.rst @@ -163,11 +163,17 @@ WriteTransport Set the *high*- and *low*-water limits for write flow control. - These two values control when call the protocol's + These two values (measured in number of + bytes) control when the protocol's :meth:`pause_writing` and :meth:`resume_writing` methods are called. If specified, the low-water limit must be less than or equal to the high-water limit. Neither *high* nor *low* can be negative. + :meth:`pause_writing` is called when the buffer size becomes greater + than or equal to the *high* value. If writing has been paused, + :meth:`resume_writing` is called when the buffer size becomes less + than or equal to the *low* value. + The defaults are implementation-specific. If only the high-water limit is given, the low-water limit defaults to an implementation-specific value less than or equal to the