diff options
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/asyncio-sync.rst | 21 |
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. |