From de9a09edf329460c5646be68149d9dce04648e86 Mon Sep 17 00:00:00 2001 From: Anton Bachin Date: Sun, 29 Mar 2020 16:38:33 +0300 Subject: [PATCH] Further tweak Luv.Loop.run docs Part of #54. [skip ci] --- src/loop.mli | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/loop.mli b/src/loop.mli index d4785e67..9889a31a 100644 --- a/src/loop.mli +++ b/src/loop.mli @@ -37,7 +37,8 @@ val run : ?loop:t -> ?mode:Run_mode.t -> unit -> bool value is [`DEFAULT]. Again, see {{:http://docs.libuv.org/en/v1.x/loop.html#c.uv_run} [uv_run]} - for information on the return value. + for information on the return value. Zero from [uv_run] corresponds to + [false] from [Luv.Loop.run], and non-zero corresponds to [true]. This function typically should not be called by a library based on Luv. Rather, it should be called by applications. *)