Opened 8 years ago

Closed 7 years ago

#4439 enhancement closed fixed (fixed)

Documentation: clarify that callback() may return before callback chain is complete

Reported by: Jason Rennie Owned by:
Priority: normal Milestone:
Component: core Keywords: documentation
Cc: Branch: branches/callback-chaining-doc-4439
branch-diff, diff-cov, branch-cov, buildbot
Author: exarkun

Description

This ticket simply requests that documentation for the callback and errback methods of twisted.internet.defer.Deferred clarify when they will return. As currently written, a programmer might assume that these methods will not return until the chain has completed. In fact, the methods will return as soon as they run into a Deferred-returning function in the chain. 'course, it's probably best to provide no guarantees as to when these functions will return in case the Twisted implementation changes.

Change History (7)

comment:1 Changed 7 years ago by Jean-Paul Calderone

Author: exarkun
Branch: branches/callback-chaining-doc-4439

(In [29049]) Branching to 'callback-chaining-doc-4439'

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

(In [29050]) Expand Deferred.callback docstring

refs #4439

comment:3 Changed 7 years ago by Jean-Paul Calderone

Keywords: documentation review added
Owner: Glyph deleted

comment:4 Changed 7 years ago by ivank

Keywords: review removed

Very minor nit: *error*- callback should be *error*-callback. Everything else looks good, please merge.

comment:5 Changed 7 years ago by ivank

Owner: set to Jean-Paul Calderone

comment:6 Changed 7 years ago by Jean-Paul Calderone

Resolution: fixed
Status: newclosed

(In [29113]) Merge callback-chaining-doc-4439

Author: exarkun Reviewer: ivank Fixes: #4439

Augment the Deferred.callback docstring with text about chaining.

comment:7 Changed 7 years ago by <automation>

Owner: Jean-Paul Calderone deleted
Note: See TracTickets for help on using tickets.