Opened 5 years ago

Last modified 5 years ago

#5775 defect new

Documentation for defer.gatherDeferreds and defer.DeferredList is not clear

Reported by: Ying Li Owned by:
Priority: normal Milestone:
Component: core Keywords: documentation
Cc: Branch:
Author:

Description (last modified by Ying Li)

The documentation for DeferredList makes mention of the DeferredList changing what callbacks/errbacks on the individual Deferreds can see, an elaboration as to why would be helpful.

The consumeErrors parameter's description is also confusingly worded, with alternating usage of the terms "included Deferreds" and "individual Deferreds". Some examples (or given the different parameters DeferredList takes, perhaps a table) would help readers understand the behaviour better.

The documentation for gatherResults has the same confusing wording. In addition, it does not mention that gatherResults is implemented with DeferredList with fireOnFirstError set to True, and thus that the Failure that is returned will be a FirstError.

Change History (4)

comment:1 Changed 5 years ago by Ying Li

Keywords: documentation added

comment:2 Changed 5 years ago by Ying Li

Description: modified (diff)

comment:3 Changed 5 years ago by Ying Li

Description: modified (diff)

comment:4 Changed 5 years ago by Ying Li

Description: modified (diff)
Note: See TracTickets for help on using tickets.