]> granicus.if.org Git - python/commitdiff
bpo-29933: Improve set_write_buffer_limits description (GH-2262)
authorKojo Idrissa <kojoidrissa@users.noreply.github.com>
Tue, 20 Jun 2017 19:32:00 +0000 (14:32 -0500)
committerMariatta <Mariatta@users.noreply.github.com>
Tue, 20 Jun 2017 19:32:00 +0000 (12:32 -0700)
Improve the description of the high and low parameters for set_write_buffer_limits.
Also fixed a small grammatical issue.

Doc/library/asyncio-protocol.rst

index 3f55506c669a29fa08d5d9ffe9c893400c269114..dfe37c239d6b39113688240e25b1f0b56b67eee7 100644 (file)
@@ -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