File tree Expand file tree Collapse file tree 1 file changed +4
-2
lines changed Expand file tree Collapse file tree 1 file changed +4
-2
lines changed Original file line number Diff line number Diff line change @@ -23,11 +23,13 @@ val run_in_the_background :
2323
2424val yield : unit -> unit
2525(* * Yield to the event loop.
26- Can only be used inside {!run} or {!run_in_the_background}. *)
26+ calling [yield] outside of {!run} or {!run_in_the_background} will raise an exception,
27+ crash your program, or otherwise cause errors. It is a programming error to do so. *)
2728
2829val await : 'a Lwt .t -> 'a
2930(* * [await prom] returns the result of [prom], or re-raises the
3031 exception with which [prom] failed if it failed.
3132 If [prom] is not resolved yet, [await prom] will suspend the
3233 current task and resume it when [prom] is resolved.
33- Can only be used inside {!run} or {!run_in_the_background}. *)
34+ calling [yield] outside of {!run} or {!run_in_the_background} will raise an exception,
35+ crash your program, or otherwise cause errors. It is a programming error to do so. *)
You can’t perform that action at this time.
0 commit comments