Add note the Task about sticky bit (#50915)

Update the docs for `Task` to mention the fact that they default to sticky. Co-authored-by: Gabriel Baraldi <[email protected]>
JuliaLang · Aug 16, 2023 · 5466d3d · 5466d3d
1 parent 1c536dd
commit 5466d3d
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/base/docs/basedocs.jl b/base/docs/basedocs.jl
@@ -1748,6 +1748,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);