diff options
author | Raymond Hettinger <python@rcn.com> | 2009-03-07 14:07:37 (GMT) |
---|---|---|
committer | Raymond Hettinger <python@rcn.com> | 2009-03-07 14:07:37 (GMT) |
commit | 47aa9897d9c2152bc13161ee115147519d099205 (patch) | |
tree | 75e304fb6650fdb2ae138cfc5636cc9dec13c73a /Doc/library/queue.rst | |
parent | f45b4cce7f5476d92439c9e93ae4b53f0ccbb2a5 (diff) | |
download | cpython-47aa9897d9c2152bc13161ee115147519d099205.zip cpython-47aa9897d9c2152bc13161ee115147519d099205.tar.gz cpython-47aa9897d9c2152bc13161ee115147519d099205.tar.bz2 |
Redocument the empty() and full() methods.
Diffstat (limited to 'Doc/library/queue.rst')
-rw-r--r-- | Doc/library/queue.rst | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/Doc/library/queue.rst b/Doc/library/queue.rst index 4ed3dcc..acd953d 100644 --- a/Doc/library/queue.rst +++ b/Doc/library/queue.rst @@ -78,6 +78,22 @@ provide the public methods described below. guarantee that put() will not block. +.. method:: Queue.empty() + + Return ``True`` if the queue is empty, ``False`` otherwise. If empty() + returns ``True`` it doesn't guarantee that a subsequent call to put() + will not block. Similarly, if empty() returns ``False`` it doesn't + guarantee that a subsequent call to get() will not block. + + +.. method:: Queue.full() + + Return ``True`` if the queue is full, ``False`` otherwise. If full() + returns ``True`` it doesn't guarantee that a subsequent call to get() + will not block. Similarly, if full() returns ``False`` it doesn't + guarantee that a subsequent call to put() will not block. + + .. method:: Queue.put(item[, block[, timeout]]) Put *item* into the queue. If optional args *block* is true and *timeout* is |