Ticket #3628 defect assigned

Opened 4 years ago

Last modified 2 years ago

"Asynchronous Programming With Twisted" says that reactor.run and reactor.stop are "not usual" but don't explain what is

Reported by: radix Owned by: thijs
Priority: normal Milestone:
Component: core Keywords: documentation twistd
Cc: khorn, thijs Branch:
Author: Launchpad Bug:

Description

First of all, they *are* usual - they're the usual ways to manage the reactor if you're using the reactor API to do it. I *assume* the document is talking about 'twistd', but it doesn't mention the tool once in the entire document.

Either these assertions need to be qualified with an explanation of twistd, or they should be removed entirely.

Attachments

async.patch Download (0.9 KB) - added by cary 4 years ago.

Change History

1

Changed 4 years ago by cary

  • owner changed from glyph to cary

2

Changed 4 years ago by cary

  • owner cary deleted
  • keywords documentation, review added; documentation removed

I rephrased these comments. Attempting to explain twistd in this context would probably confuse folks.

Changed 4 years ago by cary

3

Changed 4 years ago by cary

  • owner set to dreid

4

Changed 4 years ago by cary

  • owner dreid deleted

5

Changed 4 years ago by glyph

  • owner set to cary
  • keywords documentation added; documentation, review removed

Please wrap the comments to 80 columns; in examples, it's even more important than usual, since preformatted text tends to run off the margin of a browser pretty easily.

I think it would also be helpful to add a reference to the Twisted plugins system to the 'see also' at the bottom of the document, explaining that larger programs typically do not call reactor.run themselves.

You might also want to have a look at the work that has gone into #1490, which might help to obviate the need for reactor.run all over the place in example code.

6

Changed 3 years ago by khorn

  • cc khorn added

7

Changed 3 years ago by exarkun

  • keywords twistd added

8

Changed 2 years ago by thijs

  • owner changed from cary to thijs
  • cc thijs added
  • status changed from new to assigned
Note: See TracTickets for help on using tickets.