Mercurial > cpython-lru_cache-weakref
diff Doc/lib/libqueue.tex @ 7768:8f177933c41f legacy-trunk
Use the new {methoddesc} and {memberdesc} environments as appropriate.
| author | Fred Drake <fdrake@acm.org> |
|---|---|
| date | Fri, 27 Mar 1998 05:27:08 +0000 |
| parents | 3d1590b5e3dd |
| children | 8e5223680a9d |
line wrap: on
line diff
--- a/Doc/lib/libqueue.tex Fri Mar 27 05:25:43 1998 +0000 +++ b/Doc/lib/libqueue.tex Fri Mar 27 05:27:08 1998 +0000 @@ -37,34 +37,32 @@ 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}
