Skip to content

Commit

Permalink
docstring update
Browse files Browse the repository at this point in the history
  • Loading branch information
carstenbauer committed Mar 22, 2024
1 parent 14d5f25 commit 36391cc
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/experimental.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 36391cc

Please sign in to comment.