Add extra tips for running IO #885
Merged
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
nomisRev
reviewed
Jun 13, 2018
| @@ -40,6 +42,8 @@ All exceptions that would happen on the function parameter are automatically cap | |||
|
|
|||
| It runs the current `IO` asynchronously, calling the callback parameter on completion and returning its result. | |||
|
|
|||
| The operation will not yield a result immediately; ultimately to start running the suspended computation you have to evaluate that new instance using an unsafe operator like `unsafeRunAsync` or `unsafeRunSync` for `IO`. | |||
|
|
|||
| ```kotlin | |||
There was a problem hiding this comment.
Any reason we are not using ank on these snippets?
Could we perhaps add an additional snippet to accompany the added docs?
val io = IO<Int> { throw RuntimeException("Boom!") }
.runAsync { result ->
result.fold({ IO { println("Error") } }, { IO { println(it.toString()) } })
}
The operation will ...
There was a problem hiding this comment.
Async operations fail to execute on Ank. That snippet is right below this paragraph, if you expand the file.
nomisRev
approved these changes
Jun 13, 2018
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.
Requested on gitter, it explains why
runAsyncdoesn't start immediately.