add note to Experimental.@sync explaining difference to @sync (#5…

…1427)
JuliaLang · Sep 22, 2023 · 43f7538 · 43f7538
1 parent 8bc6c35
commit 43f7538
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/base/experimental.jl b/base/experimental.jl
@@ -92,6 +92,10 @@ are complete, or at least one of them has errored. The first exception is immedi
 rethrown. It is the responsibility of the user to cancel any still-running operations
 during error handling.
 
+!!! Note
+    This is different to [`@sync`](@ref) in that errors from wrapped tasks are thrown immediately,
+    potentially before all tasks have returned.
+
 !!! Note
     This interface is experimental and subject to change or removal without notice.
 """