This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: asyncio WriteTransport documentation typo
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.6, Python 3.4, Python 3.5
process
Status: closed Resolution: not a bug
Dependencies: Superseder:
Assigned To: docs@python Nosy List: asvetlov, docs@python, socketpair
Priority: normal Keywords:

Created on 2015-11-27 23:22 by socketpair, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Messages (2)
msg255508 - (view) Author: Марк Коренберг (socketpair) * Date: 2015-11-27 23:22
Here is the match against master.


Doc/library/asyncio-protocol.rst:

@@ -156,9 +156,9 @@ WriteTransport
       high-water limit is given, the low-water limit defaults to an
       implementation-specific value less than or equal to the
       high-water limit.  Setting *high* to zero forces *low* to zero as
-      well, and causes :meth:`pause_writing` to be called whenever the
+      well, and causes :meth:`resume_writing` to be called whenever the
       buffer becomes non-empty.  Setting *low* to zero causes
-      :meth:`resume_writing` to be called only once the buffer is empty.
+      :meth:`pause_writing` to be called only once the buffer is empty.
       Use of zero for either limit is generally sub-optimal as it
       reduces opportunities for doing I/O and computation
       concurrently.
msg255709 - (view) Author: Andrew Svetlov (asvetlov) * (Python committer) Date: 2015-12-02 11:48
I think the doc is correct.
`pause_writing` is called when write buffer becomes non empty, empty buffer is precondition for `resume_writing` call.
History
Date User Action Args
2022-04-11 14:58:24adminsetgithub: 69942
2015-12-02 11:48:49asvetlovsetstatus: open -> closed

versions: - Python 3.2, Python 3.3
nosy: + asvetlov

messages: + msg255709
resolution: not a bug
stage: resolved
2015-11-27 23:22:04socketpaircreate