[Twisted-Python] general documentation question

Christopher Armstrong radix at twistedmatrix.com
Sun Feb 11 10:58:35 EST 2007


On 2/11/07, Lee Connell <lee.a.connell at gmail.com> wrote:
> I am trying to get use to the documentation in twisted, as I am new to
> python as well.  I am using a LineReceiver class for a client I am building.
>  There are some attributes like "connected, delimiter, transport".  I am
> having a tough time finding them within the twisted documentation.  I've
> looked at all subclasses that I can see that are related to LineReceiver and
> can't seem to find where they are defined.  I did find a twistedmatrix user
> that has these listed, but how do I find this in official documentation?
>
> Here is the link I am referring too.
> http://twistedmatrix.com/users/jh/teud/Twisted/twisted.protocols.protocol.html#Protocol

Yuck. That stuff is super old and I'm surprised it's still even there.

Anyway, it appears 'transport' is unfortunately not actually mentioned
anywhere where it should be in the API docs (which is the Protocol
class, probably). 'delimiter' is fortunately documented in the
LineReceiver class. I'm not sure 'connected' is actually public, but
even if it is it is a pretty useless attribute.

http://twistedmatrix.com/documents/current/api/twisted.protocols.basic.LineReceiver.html

-- 
Christopher Armstrong
International Man of Twistery
http://radix.twistedmatrix.com/
http://twistedmatrix.com/
http://canonical.com/




More information about the Twisted-Python mailing list