Skip to content

Commit

Permalink
Add note the Task about sticky bit (#50915)
Browse files Browse the repository at this point in the history
Update the docs for `Task` to mention
the fact that they default to sticky.

Co-authored-by: Gabriel Baraldi <[email protected]>
(cherry picked from commit 5466d3d)
  • Loading branch information
vchuravy authored and nalimilan committed Nov 5, 2023
1 parent fc452e7 commit 78ae4dc
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions base/docs/basedocs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -1744,6 +1744,12 @@ Create a `Task` (i.e. coroutine) to execute the given function `func` (which
must be callable with no arguments). The task exits when this function returns.
The task will run in the "world age" from the parent at construction when [`schedule`](@ref)d.
!!! warning
By default tasks will have the sticky bit set to true `t.sticky`. This models the
historic default for [`@async`](@ref). Sticky tasks can only be run on the worker thread
they are first scheduled on. To obtain the behavior of [`Threads.@spawn`](@ref) set the sticky
bit manually to `false`.
# Examples
```jldoctest
julia> a() = sum(i for i in 1:1000);
Expand Down

0 comments on commit 78ae4dc

Please sign in to comment.