Opened 11 years ago

Closed 9 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: Jean-Paul Calderone, Thijs Triemstra Branch:
Author:

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 Triemstra 9 years ago.

Download all attachments as: .zip

Change History (8)

comment:1 Changed 10 years ago by itamarst

Summary: Misleading doc stringMisleading doc string for callFromThread

comment:2 Changed 9 years ago by Jean-Paul Calderone

Cc: Jean-Paul Calderone 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 9 years ago by Thijs Triemstra

Cc: Thijs Triemstra added
Owner: changed from itamarst to Thijs Triemstra
Priority: normalhigh
Status: newassigned

comment:4 in reply to:  2 Changed 9 years ago by Thijs Triemstra

Keywords: review added
Owner: Thijs Triemstra deleted
Status: assignednew

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 9 years ago by Thijs Triemstra

comment:5 Changed 9 years ago by therve

Keywords: callFromThread review removed
Owner: set to Thijs Triemstra

Please apply.

comment:6 Changed 9 years ago by Thijs Triemstra

Resolution: fixed
Status: newclosed

(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 7 years ago by <automation>

Owner: Thijs Triemstra deleted
Note: See TracTickets for help on using tickets.