From: Victor Stinner <victor.stinner@gmail.com>
Date: Mon, 22 Dec 2014 21:07:06 +0000 (+0100)
Subject: asyncio doc: Fix doc of get and put methods of Queue
X-Git-Tag: v3.5.0a1~283^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=4f9b773a641734cc1ca43e9ff138a78759d56fb9;p=python

asyncio doc: Fix doc of get and put methods of Queue
---

diff --git a/Doc/library/asyncio-sync.rst b/Doc/library/asyncio-sync.rst
index cc80bd79b4..c63447bbab 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.