From bddd985d3eb835c319c8c6650542a8a67cadfa59 Mon Sep 17 00:00:00 2001 From: Carsten Bauer Date: Mon, 18 Mar 2024 19:41:13 +0100 Subject: [PATCH] update docstring --- src/tools.jl | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/tools.jl b/src/tools.jl index f6a1d0d4..5e4079ed 100644 --- a/src/tools.jl +++ b/src/tools.jl @@ -25,8 +25,10 @@ Return a `UInt` identifier for the current running [Task](https://docs.julialang taskid() = objectid(current_task()) """ -When `try_enter(s::SectionSingle) do ... end` is called from multiple parallel tasks only -a single task will run the content of the `do ... end` block. +May be used to implement a "single" section in parallel code. This section will only be +run by a single task (other tasks will skip over it). + +See [`try_enter`](@ref). """ struct SectionSingle first::Base.RefValue{Bool}