Opened 6 years ago
Closed 5 years ago
#5918 enhancement closed fixed (fixed)
t.p.b.StatefulStringProtocol has undocumented .state instance attribute
| Reported by: | Devin Jeanpierre | Owned by: | Thijs Triemstra |
|---|---|---|---|
| Priority: | normal | Milestone: | |
| Component: | core | Keywords: | documentation |
| Cc: | Thijs Triemstra | Branch: |
branches/state-doc-5918
branch-diff, diff-cov, branch-cov, buildbot |
| Author: | thijs |
Description
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.)
Change History (6)
comment:1 Changed 6 years ago by
| Cc: | Thijs Triemstra added |
|---|---|
| Keywords: | documentation added |
comment:2 Changed 5 years ago by
| Author: | → thijs |
|---|---|
| Branch: | → branches/state-doc-5918 |
comment:4 Changed 5 years ago by
| Keywords: | review added |
|---|
Added documentation and forced a build. Up for review.
comment:5 Changed 5 years ago by
| Keywords: | review removed |
|---|---|
| Owner: | set to Thijs Triemstra |
Looks good. Please commit.
comment:6 Changed 5 years ago by
| Resolution: | → fixed |
|---|---|
| Status: | new → closed |
Note: See
TracTickets for help on using
tickets.
(In [37212]) Branching to 'state-doc-5918'