]> granicus.if.org Git - python/commitdiff
[3.5] bpo-29933: Improve set_write_buffer_limits description (GH-2262) (GH-2533)
authorKojo Idrissa <kojoidrissa@users.noreply.github.com>
Sun, 2 Jul 2017 02:47:56 +0000 (11:47 +0900)
committerMariatta <Mariatta@users.noreply.github.com>
Sun, 2 Jul 2017 02:47:56 +0000 (19:47 -0700)
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)

Doc/library/asyncio-protocol.rst

index 2e1a11bed7503b1eff2b61ed37f253117515c7bb..435eb3b37ad2fa2eba2347cbb5e10839604fb297 100644 (file)
@@ -160,11 +160,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