Opened 4 years ago

Closed 4 years ago

#4882 defect closed fixed (fixed)

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
(diff, github, buildbot, log)
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 (5)

comment:1 Changed 4 years ago by exarkun

  • Author set to exarkun
  • Branch set to branches/fireononecallback-4882

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

comment:2 Changed 4 years ago by exarkun

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

refs #4882

comment:3 Changed 4 years ago by exarkun

  • Keywords review added

comment:4 Changed 4 years ago by ralphm

  • Keywords review removed
  • Owner set to exarkun

Awesome! Please merge.

comment:5 Changed 4 years ago by exarkun

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

(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.