From 36391cc06a524c9ce901b3d5dcf77dadd7f1e2c3 Mon Sep 17 00:00:00 2001 From: Carsten Bauer Date: Fri, 22 Mar 2024 09:18:26 +0100 Subject: [PATCH] docstring update --- src/experimental.jl | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/experimental.jl b/src/experimental.jl index 35217dae..4bd91ba6 100644 --- a/src/experimental.jl +++ b/src/experimental.jl @@ -8,6 +8,9 @@ Specifically, a task can only pass the `@barrier` if `n-1` other tasks have reac as well. The value of `n` is determined from `@set ntasks=...`, which is required if one wants to use `@barrier`. +Because this feature is experimental, it is required to load `@barrier` explicitly, e.g. via +`using OhMyThreads.Experimental: @barrier`. + **WARNING:** It is the responsibility of the user to ensure that the right number of tasks actually reach the barrier. Otherwise, a **deadlock** can occur. In partictular, if the number of iterations is not a multiple of `n`, the last few iterations (remainder) will be