Skip to content

Commit

Permalink
update docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
carstenbauer committed Mar 18, 2024
1 parent 01deac5 commit bddd985
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions src/tools.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down

0 comments on commit bddd985

Please sign in to comment.