Skip to content

Commit

Permalink
mention dont_wait in async documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
raphael-proust committed Nov 23, 2020
1 parent 6341ef8 commit 227c0f9
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/core/lwt.mli
Original file line number Diff line number Diff line change
Expand Up @@ -824,7 +824,8 @@ val async : (unit -> unit t) -> unit
[!]{!Lwt.async_exception_hook}.
[!]{!Lwt.async_exception_hook} typically prints an error message and
terminates the program.
terminates the program. If you need a similar behaviour with a different
exception handler, you can use {!Lwt.dont_wait}.
[Lwt.async] is misleadingly named. Itself, it has nothing to do with
asynchronous execution. It's actually a safety function for making Lwt
Expand Down

0 comments on commit 227c0f9

Please sign in to comment.