mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-01 10:45:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 15

Use the new {methoddesc} and {memberdesc} environments as appropriate.

Browse source
This commit is contained in:
Fred Drake 1998-03-27 05:27:08 +00:00
parent ec56109a0a
commit 8fe533e6a0
16 changed files with 402 additions and 414 deletions
Download patch file Download diff file Expand all files Collapse all files

26
Doc/lib/libqueue.tex
View file

@ -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}