Apply suggestions from code review

c-cube · raphael-proust · web-flow · commit 7145d6138a09 · 2025-07-09T22:05:07.000-04:00
Co-authored-by: Raphaël Proust &lt;raphael-proust@users.noreply.github.com&gt;
diff --git a/src/direct/lwt_direct.mli b/src/direct/lwt_direct.mli
@@ -23,11 +23,13 @@ val run_in_the_background :
 
 val yield : unit -> unit
 (** Yield to the event loop.
-    Can only be used inside {!run} or {!run_in_the_background}. *)
+    calling [yield] outside of {!run} or {!run_in_the_background} will raise an exception,
+    crash your program, or otherwise cause errors. It is a programming error to do so. *)
 
 val await : 'a Lwt.t -> 'a
 (** [await prom] returns the result of [prom], or re-raises the
     exception with which [prom] failed if it failed.
     If [prom] is not resolved yet, [await prom] will suspend the
     current task and resume it when [prom] is resolved.
-    Can only be used inside {!run} or {!run_in_the_background}. *)
+    calling [yield] outside of {!run} or {!run_in_the_background} will raise an exception,
+    crash your program, or otherwise cause errors. It is a programming error to do so. *)
