[Python-bugs-list] [ python-Bugs-489513 ] asyncore docs: no loop(), funny structur

[noreply@sourceforge.net]

Bugs item #489513, was opened at 2001-12-05 11:56
You can respond by visiting: 
http://sourceforge.net/tracker/?func=detail&atid=105470&aid=489513&group_id=5470

Category: Documentation
Group: Python 2.2
Status: Open
Resolution: None
Priority: 5
Submitted By: Skip Montanaro (montanaro)
Assigned to: Fred L. Drake, Jr. (fdrake)
Summary: asyncore docs: no loop(), funny structur

Initial Comment:
asyncore.loop is not documented.  Here's a cut at 
it:

\begin{funcdesc}{loop}{\optional{timeout=30.0\optional{,
use_poll=0\optional{, 
map=None}}}}
  Enter a polling loop that only terminates after 
all open channels have
  been closed.  All arguments are 
optional.  The \var{timeout} argument sets
  the timeout 
parameter for the appropriate \func{select} or \func{poll}
  call.  
The \var{use_poll} parameter, if true, indicates that 
\func{poll}
  should be used in preference to \func{select}.  The 
\data{map} parameter
  is a dictionary that gives a list of 
channels to watch.  As channels are
  closed they are deleted 
from their map.
\end{funcdec}

Also, I noticed that the 
structure of the doc is
a bit odd.  There are several 
methoddesc blocks in 
the documentation after the close of 
the classdesc 
block for the dispatcher class. 


----------------------------------------------------------------------

You can respond by visiting: 
http://sourceforge.net/tracker/?func=detail&atid=105470&aid=489513&group_id=5470