Documentation improvements: Lwt_main.run and Lwt_io.wait_read/wait_write #547
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
started by a program.
…y when interfacing with existing blocking code.
hcarty
reviewed
Feb 13, 2018
src/unix/lwt_main.mli
Outdated
| {[ | ||
| let main () = Lwt_io.write_line Lwt_io.stdout "hello world" | ||
|
|
||
| let _ = |
There was a problem hiding this comment.
It may be better to use let () = here to encourage more a more precise definition of what's being returned.
src/unix/lwt_main.mli
Outdated
| @@ -28,6 +28,18 @@ val run : 'a Lwt.t -> 'a | |||
| then returns the value returned by the thread. If [t] fails with | |||
| an exception, this exception is raised. | |||
|
|
|||
| Every program that uses Lwt should always use this function to launch | |||
| their threads, otherwise correct scheduling is not guaranteed. | |||
There was a problem hiding this comment.
If I understand correctly, this is not true when targeting Javascript via js_of_ocaml. It is true for native and bytecode compilation.
There was a problem hiding this comment.
Indeed, JS environments have the equivalent of Lwt_main.run built into them, conversely Lwt_main.run isn't even available when targeting JS.
|
Thanks :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Myself I've found the documentation for them confusingly incomplete and attempted to not use the former when necessary and use the latter when not necessary.