Ticket #5044 enhancement closed fixed

Opened 2 years ago

Last modified 21 months ago

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

Reported by: itamar Owned by: itamar
Priority: normal Milestone:
Component: core Keywords: documentation
Cc: Branch: branches/explicit-buildProtocol-5044
(diff, github, buildbot, log)
Author: itamarst Launchpad Bug:

Description

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

1

Changed 21 months ago by itamarst

  • branch set to branches/explicit-buildProtocol-5044
  • branch_author set to itamarst

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

2

Changed 21 months ago by itamar

  • keywords review added

Ready for review.

3

Changed 21 months ago by exarkun

  • owner set to itamar
  • keywords review removed

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. :)

4

Changed 21 months ago by itamarst

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

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