]> granicus.if.org Git - python/commitdiff
asyncio doc: Fix doc of get and put methods of Queue
authorVictor Stinner <victor.stinner@gmail.com>
Mon, 22 Dec 2014 21:07:06 +0000 (22:07 +0100)
committerVictor Stinner <victor.stinner@gmail.com>
Mon, 22 Dec 2014 21:07:06 +0000 (22:07 +0100)
Doc/library/asyncio-sync.rst

index cc80bd79b4a20a0335b000ad2d13c7022d54407c..c63447bbab41fc2d655c5add9807308b186aac26 100644 (file)
@@ -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.