Ticket #5918 enhancement closed fixed

Opened 9 months ago

Last modified 3 months ago

t.p.b.StatefulStringProtocol has undocumented .state instance attribute

Reported by: devinj Owned by: thijs
Priority: normal Milestone:
Component: core Keywords: documentation
Cc: thijs Branch: branches/state-doc-5918
Author: thijs Launchpad Bug:

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

1

Changed 8 months ago by thijs

  • cc thijs added
  • keywords documentation added

2

Changed 3 months ago by thijs

  • branch set to branches/state-doc-5918
  • branch_author set to thijs

(In [37212]) Branching to 'state-doc-5918'

3

Changed 3 months ago by thijs

(In [37213]) document state attr, add news file. refs #5918

4

Changed 3 months ago by thijs

  • keywords review added

Added documentation and forced a  build. Up for review.

5

Changed 3 months ago by tom.prince

  • owner set to thijs
  • keywords review removed

Looks good. Please commit.

6

Changed 3 months ago by thijs

  • status changed from new to closed
  • resolution set to fixed

(In [37248]) Merge state-doc-5918: Documented the state attribute of StatefulStringProtocol.

Author: thijs Reviewer: tom.prince Fixes: #5918

Note: See TracTickets for help on using tickets.