Opened 8 years ago

Closed 8 years ago

#5044 enhancement closed fixed (fixed)

Client documentation should use explicit buildProtocol()s rather than magic "protocol = MyProtocol" on factories

Reported by: Itamar Turner-Trauring Owned by: Itamar Turner-Trauring
Priority: normal Milestone:
Component: core Keywords: documentation
Cc: Branch: branches/explicit-buildProtocol-5044
branch-diff, diff-cov, branch-cov, buildbot
Author: itamarst


Observation at the Twisted Lab in Boston suggests that buildProtocol as an important protocol/factory integration point is hard for new users to understand. The client howto should use buildProtocol by default, but also explain the "protocol = ProtocolClass" shortcut.

Change History (4)

comment:1 Changed 8 years ago by itamarst

Author: itamarst
Branch: branches/explicit-buildProtocol-5044

(In [32546]) Branching to 'explicit-buildProtocol-5044'

comment:2 Changed 8 years ago by Itamar Turner-Trauring

Keywords: review added

Ready for review.

comment:3 Changed 8 years ago by Jean-Paul Calderone

Keywords: review removed
Owner: set to Itamar Turner-Trauring

The news fragment should be a .doc or a .misc. Also, is this really a change about "consistency"? Or explicitness (as the ticket summary and branch name seem to express)?

The code and doc changes themselves look great. Please merge once the news file reflects something an application developer would want to read about. :)

comment:4 Changed 8 years ago by itamarst

Resolution: fixed
Status: newclosed

(In [32757]) Merge explicit-buildProtocol-5044. Fixes: #5044 Author: itamar Review: exarkun

The clients howto now uses buildProtocol more explicitly, hopefully making it clearer where protocols come from.

Note: See TracTickets for help on using tickets.