Clarify Lwt.join docs somewhat

[skip ci]
ocsigen · Dec 27, 2017 · 5c19936 · 5c19936
1 parent e8b74b0
commit 5c19936
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/core/lwt.mli b/src/core/lwt.mli
@@ -943,7 +943,8 @@ let () =
     If all of the promises in [ps] become fulfilled, [Lwt.join ps] is also
     fulfilled. Otherwise, if at least one promise in [ps] becomes rejected,
     [Lwt.join ps] is rejected with the same exception as one such promise,
-    chosen arbitrary. *)
+    chosen arbitrarily. Note that this occurs only after all the promises are
+    resolved, not immediately when the first promise is rejected. *)