Opened 4 years ago

Closed 4 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


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 4 years ago by Thijs Triemstra

Cc: Thijs Triemstra added
Keywords: documentation added

comment:2 Changed 4 years ago by Thijs Triemstra

Author: thijs
Branch: branches/state-doc-5918

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

comment:3 Changed 4 years ago by Thijs Triemstra

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

comment:4 Changed 4 years ago by Thijs Triemstra

Keywords: review added

Added documentation and forced a build. Up for review.

comment:5 Changed 4 years ago by Tom Prince

Keywords: review removed
Owner: set to Thijs Triemstra

Looks good. Please commit.

comment:6 Changed 4 years ago by Thijs Triemstra

Resolution: fixed
Status: newclosed

(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.