Opened 7 years ago

Last modified 5 years ago

#5988 enhancement new

Add howto-style documentation for `twisted.internet.task.react`.

Reported by: Jean-Paul Calderone Owned by:
Priority: normal Milestone:
Component: core Keywords: documentation
Cc: Richard Wall, Thijs Triemstra, khorn, ralphm Branch:
Author:

Description

This is the API that basically everyone writing a client should be using to run the reactor (at least until #5705 is resolved - and #5705 should likely be implemented using this API).

One example (Twisted Words' xmpp client) uses it, and that's it. There's no way anyone will ever find out about it. Somewhere early on in the documentation path (for command line and/or client development) new users are introduced to, they need to be shown this API and told to use it instead of calling reactor.run() directly.

Change History (5)

comment:1 Changed 7 years ago by Richard Wall

Cc: Richard Wall added

I converted the twisted.names examples to use react. See #5596 and #5989

comment:2 Changed 7 years ago by Thijs Triemstra

Cc: Thijs Triemstra added

comment:3 Changed 6 years ago by Adam Dangoor

Link the docstring for twisted.internet.task.react to the narrative documentation (perhaps instead of the example code for the main parameter). See #6071.

comment:4 Changed 5 years ago by khorn

Cc: khorn added

comment:5 Changed 5 years ago by ralphm

Cc: ralphm added
Note: See TracTickets for help on using tickets.