Enrich the delay scaladoc for IO and Sync
#2654
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
danicheg
force-pushed
the
delay-scaladoc
branch
from
7fcdc26 to
f2438ff
Compare
danicheg
commented
Dec 16, 2021
| @@ -931,13 +931,19 @@ object IO extends IOCompanionPlatform with IOLowPriorityImplicits { | |||
|
|
|||
| /** | |||
| * Suspends a synchronous side effect in `IO`. | |||
| * Use [[IO.apply]] if your side effect is not thread-blocking; | |||
| * otherwise you should use [[IO.blocking]] or `IO.interruptible` | |||
There was a problem hiding this comment.
Unfortunately, the direct link to the IO.interruptible is ambiguous. And it could be fixed only by a fully qualified name. That's too extra, I think.
There was a problem hiding this comment.
Hmm, that's annoying. I actually don't know how to do that anyway :)
armanbilge
reviewed
Dec 16, 2021
Co-authored-by: Arman Bilge @armanbilge armanbilge@gmail.com
armanbilge
approved these changes
Dec 16, 2021
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.
This is a minor thing but should help in picking a suitable constructor.