Skip to content

Commit

Permalink
Add usage note of waitall in docstring
Browse files Browse the repository at this point in the history
Co-authored-by: Jameson Nash <vtjnash@gmail.com>
  • Loading branch information
mrkn and vtjnash authored Mar 9, 2024
1 parent 3186c03 commit 4b35a76
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions base/task.jl
Original file line number Diff line number Diff line change
Expand Up @@ -377,6 +377,12 @@ completed tasks completes with an exception.
The return value consists of two task vectors. The first one consists of
completed tasks, and the other consists of uncompleted tasks.
!!! warning
This may scale poorly compared to writing code that uses multiple individual tasks that
each runs serially, since this needs to scan the list of `tasks` each time and
synchronize with each one every time this is called. Or consider using
[`waitall(tasks; failfast=true)`](@ref waitall) instead.
"""
waitany(tasks; throw=true) = _wait_multiple(tasks, throw)

Expand Down

0 comments on commit 4b35a76

Please sign in to comment.