Improve Luv.Loop.run return value docs

Part of #54.

README.md

@@ -33,7 +33,7 @@ let () =
     end
   end;
 
-  Luv.Loop.run () |> ignore
+  ignore (Luv.Loop.run () : bool)
 ```
 
 <br/>

example/cat.ml

@@ -29,4 +29,4 @@ let () =
       Luv.File.read file [buffer] on_read
   end;
 
-  ignore (Luv.Loop.run ())
+  ignore (Luv.Loop.run () : bool)

example/delay.ml

@@ -5,4 +5,4 @@ let () =
     print_endline "Hello, world!"));
 
   print_endline "Waiting...";
-  ignore (Luv.Loop.run ())
+  ignore (Luv.Loop.run () : bool)

example/hello_world.ml

@@ -1,3 +1,3 @@
 let () =
   print_endline "Hello, world!";
-  ignore (Luv.Loop.run ())
+  ignore (Luv.Loop.run () : bool)

example/host.ml

@@ -7,4 +7,4 @@ let () =
         (Option.get (Luv.Sockaddr.to_string (List.hd addr_infos).addr))
   end;
 
-  ignore (Luv.Loop.run ())
+  ignore (Luv.Loop.run () : bool)

example/http_get.ml

@@ -33,4 +33,4 @@ let () =
       end
   end;
 
-  ignore (Luv.Loop.run ())
+  ignore (Luv.Loop.run () : bool)

example/idle.ml

@@ -11,4 +11,4 @@ let () =
       ignore (Luv.Idle.stop idle)
   end;
 
-  ignore (Luv.Loop.run ())
+  ignore (Luv.Loop.run () : bool)

example/onchange.ml

@@ -27,4 +27,4 @@ let () =
       end
     end;
 
-  ignore (Luv.Loop.run ())
+  ignore (Luv.Loop.run () : bool)

example/pipe.ml

@@ -17,4 +17,4 @@ let () =
       print_string (Luv.Buffer.to_string buffer)
   end;
 
-  ignore (Luv.Loop.run ())
+  ignore (Luv.Loop.run () : bool)

example/pipe_echo_server.ml

@@ -24,4 +24,4 @@ let () =
         end
   end;
 
-  ignore (Luv.Loop.run ())
+  ignore (Luv.Loop.run () : bool)

example/pipe_hello_world.ml

@@ -20,4 +20,4 @@ let () =
       end
   end;
 
-  ignore (Luv.Loop.run ())
+  ignore (Luv.Loop.run () : bool)

example/progress.ml

@@ -24,4 +24,4 @@ let () =
 
   Luv.Thread_pool.queue_work (fun () -> do_work 3 0) finished;
 
-  ignore (Luv.Loop.run ())
+  ignore (Luv.Loop.run () : bool)

example/readme.ml

@@ -17,4 +17,4 @@ let () =
     end
   end;
 
-  Luv.Loop.run () |> ignore
+  ignore (Luv.Loop.run () : bool)

example/send_signal.ml

@@ -4,4 +4,4 @@ let () =
 
   ignore (Luv.Process.kill child Luv.Signal.sigkill);
 
-  ignore (Luv.Loop.run ())
+  ignore (Luv.Loop.run () : bool)

example/sigint.ml

@@ -8,4 +8,4 @@ let () =
 
   print_endline "Type Ctrl+C to continue...";
 
-  ignore (Luv.Loop.run ())
+  ignore (Luv.Loop.run () : bool)

example/spawn.ml

@@ -1,3 +1,3 @@
 let () =
   ignore (Luv.Process.spawn "sleep" ["sleep"; "1"]);
-  ignore (Luv.Loop.run ())
+  ignore (Luv.Loop.run () : bool)

example/stdout.ml

@@ -4,4 +4,4 @@ let () =
   ]
   in
   ignore (Luv.Process.spawn ~redirect "echo" ["echo"; "Hello,"; "world!"]);
-  ignore (Luv.Loop.run ())
+  ignore (Luv.Loop.run () : bool)

example/tcp_echo_server.ml

@@ -25,4 +25,4 @@ let () =
         end
   end;
 
-  ignore (Luv.Loop.run ())
+  ignore (Luv.Loop.run () : bool)

example/tcp_hello_world.ml

@@ -21,4 +21,4 @@ let () =
       end
   end;
 
-  ignore (Luv.Loop.run ())
+  ignore (Luv.Loop.run () : bool)

example/thread_pool.ml

@@ -4,4 +4,4 @@ let () =
     print_endline "Finished")
     ignore;
 
-  ignore (Luv.Loop.run ())
+  ignore (Luv.Loop.run () : bool)

example/udp_echo_server.ml

@@ -12,4 +12,4 @@ let () =
       Luv.UDP.send server [buffer] client_address ignore
   end;
 
-  ignore (Luv.Loop.run ())
+  ignore (Luv.Loop.run () : bool)

example/udp_hello_world.ml

@@ -14,4 +14,4 @@ let () =
       Luv.Handle.close client ignore
   end;
 
-  ignore (Luv.Loop.run ())
+  ignore (Luv.Loop.run () : bool)

src/index.mld

@@ -24,7 +24,7 @@ let () =
     end
   end;
 
-  Luv.Loop.run () |> ignore
+  ignore (Luv.Loop.run () : bool)
 ]}
 
 This is the auto-generated API reference. For more conceptual information and

src/loop.mli

@@ -36,6 +36,9 @@ val run : ?loop:t -> ?mode:Run_mode.t -> unit -> bool
     meaning of the constants that can be specified with [?mode]. The default
     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.
+
     This function typically should not be called by a library based on Luv.
     Rather, it should be called by applications. *)