summaryrefslogtreecommitdiffstats
path: root/Lib/asyncio/queues.py
diff options
context:
space:
mode:
authorVictor Stinner <victor.stinner@gmail.com>2014-12-22 21:09:50 (GMT)
committerVictor Stinner <victor.stinner@gmail.com>2014-12-22 21:09:50 (GMT)
commit952ec98abb28eeda92e13c9c142f5288aecc5a21 (patch)
treeeae34b85016a99ed5d451c8e2d82238de7f67f5a /Lib/asyncio/queues.py
parent4f9b773a641734cc1ca43e9ff138a78759d56fb9 (diff)
downloadcpython-952ec98abb28eeda92e13c9c142f5288aecc5a21.zip
cpython-952ec98abb28eeda92e13c9c142f5288aecc5a21.tar.gz
cpython-952ec98abb28eeda92e13c9c142f5288aecc5a21.tar.bz2
asyncio doc: update also Queue docstrings
Diffstat (limited to 'Lib/asyncio/queues.py')
-rw-r--r--Lib/asyncio/queues.py10
1 files changed, 7 insertions, 3 deletions
diff --git a/Lib/asyncio/queues.py b/Lib/asyncio/queues.py
index 41551a9..8f6c257 100644
--- a/Lib/asyncio/queues.py
+++ b/Lib/asyncio/queues.py
@@ -111,8 +111,10 @@ class Queue:
def put(self, item):
"""Put an item into the queue.
- If you yield from put(), wait until a free slot is available
- before adding item.
+ Put an item into the queue. If the queue is full, wait until a free
+ slot is available before adding item.
+
+ This method is a coroutine.
"""
self._consume_done_getters()
if self._getters:
@@ -161,7 +163,9 @@ class Queue:
def get(self):
"""Remove and return an item from the queue.
- If you yield from get(), wait until a item is available.
+ If queue is empty, wait until an item is available.
+
+ This method is a coroutine.
"""
self._consume_done_putters()
if self._putters: