diff options
author | Fred Drake <fdrake@acm.org> | 1998-03-27 05:27:08 (GMT) |
---|---|---|
committer | Fred Drake <fdrake@acm.org> | 1998-03-27 05:27:08 (GMT) |
commit | 8fe533e6a092f8f8aa8d7b81dd8f38c5057e9682 (patch) | |
tree | 3371e13f1ada67e3d7451e38fddcadbe7c098283 /Doc/lib/libqueue.tex | |
parent | ec56109a0af6d3f705feffc50fc59abab1c0ccea (diff) | |
download | cpython-8fe533e6a092f8f8aa8d7b81dd8f38c5057e9682.zip cpython-8fe533e6a092f8f8aa8d7b81dd8f38c5057e9682.tar.gz cpython-8fe533e6a092f8f8aa8d7b81dd8f38c5057e9682.tar.bz2 |
Use the new {methoddesc} and {memberdesc} environments as appropriate.
Diffstat (limited to 'Doc/lib/libqueue.tex')
-rw-r--r-- | Doc/lib/libqueue.tex | 26 |
1 files changed, 12 insertions, 14 deletions
diff --git a/Doc/lib/libqueue.tex b/Doc/lib/libqueue.tex index 562623a..db6cabc 100644 --- a/Doc/lib/libqueue.tex +++ b/Doc/lib/libqueue.tex @@ -37,34 +37,32 @@ other queue organizations (e.g. stack) but the inheritable interface is not described here. See the source code for details. The public methods are: -\setindexsubitem{(Queue method)} - -\begin{funcdesc}{qsize}{} +\begin{methoddesc}{qsize}{} Returns the approximate size of the queue. Because of multithreading semantics, this number is not reliable. -\end{funcdesc} +\end{methoddesc} -\begin{funcdesc}{empty}{} +\begin{methoddesc}{empty}{} Returns \code{1} if the queue is empty, \code{0} otherwise. Because of multithreading semantics, this is not reliable. -\end{funcdesc} +\end{methoddesc} -\begin{funcdesc}{full}{} +\begin{methoddesc}{full}{} Returns \code{1} if the queue is full, \code{0} otherwise. Because of multithreading semantics, this is not reliable. -\end{funcdesc} +\end{methoddesc} -\begin{funcdesc}{put}{item} +\begin{methoddesc}{put}{item} Puts \var{item} into the queue. -\end{funcdesc} +\end{methoddesc} -\begin{funcdesc}{get}{} +\begin{methoddesc}{get}{} Gets and returns an item from the queue, blocking if necessary until one is available. -\end{funcdesc} +\end{methoddesc} -\begin{funcdesc}{get_nowait}{} +\begin{methoddesc}{get_nowait}{} Gets and returns an item from the queue if one is immediately available. Raises an \exception{Empty} exception if the queue is empty or if the queue's emptiness cannot be determined. -\end{funcdesc} +\end{methoddesc} |