Ticket #4439 enhancement closed fixed

Opened 4 years ago

Last modified 4 years ago

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

Reported by: jrennie Owned by:
Priority: normal Milestone:
Component: core Keywords: documentation
Cc: Branch: branches/callback-chaining-doc-4439
(diff, github, buildbot, log)
Author: exarkun Launchpad Bug:

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

1

Changed 4 years ago by exarkun

  • branch set to branches/callback-chaining-doc-4439
  • branch_author set to exarkun

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

2

Changed 4 years ago by exarkun

(In [29050]) Expand Deferred.callback docstring

refs #4439

3

Changed 4 years ago by exarkun

  • owner glyph deleted
  • keywords documentation, review added

4

Changed 4 years ago by ivank

  • keywords documentation added; documentation, review removed

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

5

Changed 4 years ago by ivank

  • owner set to exarkun

6

Changed 4 years ago by exarkun

  • status changed from new to closed
  • resolution set to fixed

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

Author: exarkun Reviewer: ivank Fixes: #4439

Augment the Deferred.callback docstring with text about chaining.

7

Changed 3 years ago by <automation>

  • owner exarkun deleted
Note: See TracTickets for help on using tickets.