Skip to content

Commit 98b10d0

Browse files
committed
Clarify wording on termination
1 parent 6ab3d3c commit 98b10d0

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

lib/picos_std.structured/picos_std_structured.mli

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -142,11 +142,12 @@ module Promise : sig
142142
143143
⚠️ {{!try_terminate} Canceling} a promise does not immediately terminate
144144
the fiber or wait for the fiber working to complete the promise to
145-
terminate. Constructs like {!Bundle.join_after} and {!Flock.join_after}
146-
only guarantee that all fibers forked within their scope have terminated
147-
before they return or raise. The reason for this design choice in this
148-
library is that synchronization is expensive and delaying synchronization
149-
to the join operation is typically sufficient and amortizes the cost. *)
145+
terminate. On the other hand, constructs like {!Bundle.join_after} and
146+
{!Flock.join_after} guarantee that all the fibers forked within their
147+
scope have actually terminated before they return or raise. The reason for
148+
this design choice in this library is that synchronization is expensive
149+
and delaying synchronization to the join operation is typically sufficient
150+
and amortizes the cost. *)
150151

151152
type !'a t
152153
(** Represents a promise to produce a value of type ['a]. *)

0 commit comments

Comments
 (0)