summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVictor Stinner <victor.stinner@gmail.com>2014-12-22 21:07:06 (GMT)
committerVictor Stinner <victor.stinner@gmail.com>2014-12-22 21:07:06 (GMT)
commit4f9b773a641734cc1ca43e9ff138a78759d56fb9 (patch)
tree1f42ab755dbfd793a55b814821d5962326cee277
parent10e76b67c9bb2f6febeb7f264478532cbe985ecd (diff)
downloadcpython-4f9b773a641734cc1ca43e9ff138a78759d56fb9.zip
cpython-4f9b773a641734cc1ca43e9ff138a78759d56fb9.tar.gz
cpython-4f9b773a641734cc1ca43e9ff138a78759d56fb9.tar.bz2
asyncio doc: Fix doc of get and put methods of Queue
-rw-r--r--Doc/library/asyncio-sync.rst21
1 files changed, 13 insertions, 8 deletions
diff --git a/Doc/library/asyncio-sync.rst b/Doc/library/asyncio-sync.rst
index cc80bd7..c63447b 100644
--- a/Doc/library/asyncio-sync.rst
+++ b/Doc/library/asyncio-sync.rst
@@ -293,7 +293,7 @@ Queue
.. method:: full()
- Return ``True`` if there are maxsize items in the queue.
+ Return ``True`` if there are :attr:`maxsize` items in the queue.
.. note::
@@ -302,12 +302,15 @@ Queue
.. method:: get()
- Remove and return an item from the queue.
-
- If you yield from :meth:`get()`, wait until a item is available.
+ Remove and return an item from the queue. If queue is empty, wait until
+ an item is available.
This method is a :ref:`coroutine <coroutine>`.
+ .. seealso::
+
+ The :meth:`empty` method.
+
.. method:: get_nowait()
Remove and return an item from the queue.
@@ -317,13 +320,15 @@ Queue
.. method:: put(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 :ref:`coroutine <coroutine>`.
+ .. seealso::
+
+ The :meth:`full` method.
+
.. method:: put_nowait(item)
Put an item into the queue without blocking.