-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add parallel docs #2031
Add parallel docs #2031
Conversation
Sorry I squashed the other pr, you might need to Cherry pick this one. |
Yeah I'll do that soonish :) |
4f57f66
to
d0d19f5
Compare
d0d19f5
to
08715e8
Compare
Codecov Report
@@ Coverage Diff @@
## master #2031 +/- ##
=========================================
- Coverage 95.25% 95% -0.25%
=========================================
Files 305 311 +6
Lines 5179 5266 +87
Branches 127 131 +4
=========================================
+ Hits 4933 5003 +70
- Misses 246 263 +17
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I left a couple of very minor suggestions, but I think that this is great! Feel free to merge and if we want to address these at all, it could always be in a followup PR.
## NonEmptyParallel - a weakened Parallel | ||
|
||
If you recall that some types cannot form a `Monad` or an `Applicative` because it's not possible to implement the `pure` function for them. | ||
However, these types usually can have instances for `FlatMap` or `Apply`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2 minor comments:
- This might read a little more cleanly if you drop the "If you recall that". That is, it could start with "Some types cannot...".
- "usually" might be an overly strong assertion here. Maybe just say "often"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done :)
Adds some documentation for the new
Parallel
class. Right now it depends on #1938. We should be able to give more examples once we have aParallel
instance forcats.effect.IO
:)