document how to wait for one whole iteration of main loop

ocsigen · Mar 2, 2022 · fa15b38 · fa15b38
1 parent 45b51a7
commit fa15b38
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/core/lwt.mli b/src/core/lwt.mli
@@ -1908,6 +1908,9 @@ val pause : unit -> unit t
     Putting the rest of your computation into a callback of [Lwt.pause ()]
     creates a “yield” that gives other callbacks a chance to run first.
 
+    To wait for one complete iteration of the main loop you need to wait for
+    [Lwt.pause () >>= Lwt.pause]
+
     For example, to break up a long-running computation, allowing I/O to be
     handled between chunks: