Ticket #4882 defect closed fixed

Opened 2 years ago

Last modified 2 years ago

Documentation for fireOnOneCallback parameter of DeferredList is incorrect

Reported by: exarkun Owned by: exarkun
Priority: normal Milestone:
Component: core Keywords: documentation
Cc: Branch: branches/fireononecallback-4882
Author: exarkun Launchpad Bug:

Description

The __init__ docstring says this about fireOnOneCallback:

When this flag is set, the DeferredList will fire with a two-tuple: the first element is the index in C{deferredList} of the Deferred which fired; the second element is the result of that Deferred.

The implementation of the flag looks like this, though:

            if succeeded == SUCCESS and self.fireOnOneCallback:
                self.callback((result, index))

Change History

1

Changed 2 years ago by exarkun

  • branch set to branches/fireononecallback-4882
  • branch_author set to exarkun

(In [30757]) Branching to 'fireononecallback-4882'

2

Changed 2 years ago by exarkun

(In [30758]) Swap the order of the index and result in the documentation

refs #4882

3

Changed 2 years ago by exarkun

  • keywords review added

4

Changed 2 years ago by ralphm

  • keywords review removed
  • owner set to exarkun

Awesome! Please merge.

5

Changed 2 years ago by exarkun

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

(In [30762]) Merge fireononecallback-4882

Author: exarkun Reviewer: ralphm Fixes: #4882

Correct the API documentation for the fireOnOneCallback parameter of DeferredList.

Note: See TracTickets for help on using tickets.