Opened 7 years ago

Closed 6 years ago

#2449 defect closed fixed (fixed)

Misleading doc string for callFromThread

Reported by: Scramblejams Owned by:
Priority: high Milestone:
Component: core Keywords: documentation, threads
Cc: exarkun, thijs Branch:
Author: Launchpad Bug:

Description

In...

http://twistedmatrix.com/documents/current/api/twisted.internet.interfaces.IReactorThreads.html

...the docs for reactor.callFromThread() state that the callable must be threadsafe. But according to Eric Mangold...

http://twistedmatrix.com/pipermail/twisted-python/2007-February/014855.html

...this is wrong.

Attachments (1)

misleading-callFromThread-doc.patch (1.3 KB) - added by thijs 6 years ago.

Download all attachments as: .zip

Change History (8)

comment:1 Changed 7 years ago by itamarst

  • Summary changed from Misleading doc string to Misleading doc string for callFromThread

comment:2 follow-up: Changed 6 years ago by exarkun

  • Cc exarkun added

Coming up with a phrasing to describe the behavior which is more clear and concise than the current wording is tricky. Do you have any suggestions?

comment:3 Changed 6 years ago by thijs

  • Cc thijs added
  • Owner changed from itamarst to thijs
  • Priority changed from normal to high
  • Status changed from new to assigned

comment:4 in reply to: ↑ 2 Changed 6 years ago by thijs

  • Keywords review added
  • Owner thijs deleted
  • Status changed from assigned to new

Replying to exarkun:

Coming up with a phrasing to describe the behavior which is more clear and concise than the current wording is tricky. Do you have any suggestions?

In that case let's use that alternative which is better than the current misleading doc string. See attached patch.

Changed 6 years ago by thijs

comment:5 Changed 6 years ago by therve

  • Keywords callFromThread review removed
  • Owner set to thijs

Please apply.

comment:6 Changed 6 years ago by thijs

  • Resolution set to fixed
  • Status changed from new to closed

(In [25371]) Apply misleading-callFromThread-doc.patch: make docs for reactor.callFromThread() clear about when the callable must be threadsafe.

Author: thijs
Reviewer: therve
Fixes: #2449

comment:7 Changed 3 years ago by <automation>

  • Owner thijs deleted
Note: See TracTickets for help on using tickets.