align scaladoc with examples from the official docs for IO.shift - fixes #559 #567
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
Codecov Report
@@ Coverage Diff @@
## master #567 +/- ##
==========================================
+ Coverage 84.95% 88.94% +3.98%
==========================================
Files 77 77
Lines 2247 2143 -104
Branches 128 129 +1
==========================================
- Hits 1909 1906 -3
+ Misses 338 237 -101 |
djspiewak
requested changes
Jun 14, 2019
| * | ||
| * {{{ | ||
| * import cats.effect.{IO, ContextShift} | ||
| * import scala.concurrent.ExecutionContext.Implicits.global |
There was a problem hiding this comment.
Should we be encouraging people to use global like this? I'm sure this kind of thing exists elsewhere in the docs, but I'm leery of it particularly given the problems we've seen and the fact that IOApp no longer uses it.
There was a problem hiding this comment.
I changed the docs by only outlining its basic usage - that at least removes the usage of global.
Co-Authored-By: Daniel Spiewak <djspiewak@gmail.com>
Co-Authored-By: Daniel Spiewak <djspiewak@gmail.com>
rossabaker
pushed a commit
to rossabaker/cats-effect
that referenced
this pull request
Jul 30, 2019
…l docs for IO.shift
rossabaker
pushed a commit
to rossabaker/cats-effect
that referenced
this pull request
Jul 30, 2019
…l docs for IO.shift
rossabaker
pushed a commit
to rossabaker/cats-effect
that referenced
this pull request
Jul 30, 2019
…l docs for IO.shift
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.
Fixes #559