Skip to content

Commit 0c8d97d

Browse files
polytypiclyrm
andcommitted
Clarify documentation of Computation.canceler
Co-authored-by: Carine Morel <[email protected]>
1 parent 52b92bf commit 0c8d97d

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

lib/picos/picos.mli

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -734,9 +734,9 @@ module Computation : sig
734734
[from] one computation [into] another on {{:Trigger.signal} signal}. The
735735
returned trigger is not attached to any computation.
736736
737-
The returned trigger is usually attached to the computation [from] which
738-
cancelation is to be propagated and the trigger should usually also be
739-
detached after it is no longer needed.
737+
The caller usually attaches the returned trigger to the computation [from]
738+
which cancelation is to be propagated and the trigger should usually also
739+
be detached after it is no longer needed. See also {!attach_canceler}.
740740
741741
The intended use case of [canceler] is as a low level building block of
742742
structured concurrency mechanisms. Picos does not require concurrent

0 commit comments

Comments
 (0)