id,summary,reporter,owner,description,type,status,priority,milestone,component,resolution,keywords,cc,branch,branch_author,launchpad_bug
5918,t.p.b.StatefulStringProtocol has undocumented .state instance attribute,devinj,thijs,"http://twistedmatrix.com/trac/browser/tags/releases/twisted-12.1.0/twisted/protocols/basic.py#L846

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

I'm not sure that instance attributes are universally supposed to be documented, but the attribute name ""state"" is useful enough for others (and nonobvious enough in subclasses, e.g. AMP) that maybe it should be documented. I ran into this problem last year when I used state as an instance attribute for a subclass, and found it very confusing. (At the time, I forgot to report the missing documentation, sorry.)",enhancement,closed,normal,,core,fixed,documentation,thijs,branches/state-doc-5918,thijs,