From 01026fafaa6e3d0f1d434b5b586528342fd9d330 Mon Sep 17 00:00:00 2001 From: Simon Cruanes Date: Fri, 5 Sep 2025 10:23:45 -0400 Subject: [PATCH] doc --- src/lwt/moonpool_lwt.mli | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/lwt/moonpool_lwt.mli b/src/lwt/moonpool_lwt.mli index 4553d5b7..c97bbec1 100644 --- a/src/lwt/moonpool_lwt.mli +++ b/src/lwt/moonpool_lwt.mli @@ -39,7 +39,8 @@ val run_in_lwt_and_await : (unit -> 'a Lwt.t) -> 'a val on_uncaught_exn : (Moonpool.Exn_bt.t -> unit) ref val lwt_main : (Moonpool.Runner.t -> 'a) -> 'a -(** Setup, run lwt main, return the result *) +(** [lwt_main f] sets the moonpool-lwt bridge up, runs lwt main, calls [f], + destroys the bridge, and return the result of [f()]. *) val lwt_main_runner : unit -> Moonpool.Runner.t (** The runner from {!lwt_main}. The runner is only going to work if {!lwt_main} @@ -47,3 +48,4 @@ val lwt_main_runner : unit -> Moonpool.Runner.t @raise Failure if {!lwt_main} was not called. *) val is_setup : unit -> bool +(** Is the moonpool-lwt bridge setup? *)