Skip to content
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

Merged
merged 2 commits into from
Nov 28, 2017
Merged

Add parallel docs #2031

merged 2 commits into from
Nov 28, 2017

Conversation

LukaJCB
Copy link
Member

@LukaJCB LukaJCB commented Nov 17, 2017

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 a Parallel instance for cats.effect.IO :)

@kailuowang
Copy link
Contributor

Sorry I squashed the other pr, you might need to Cherry pick this one.

@LukaJCB
Copy link
Member Author

LukaJCB commented Nov 18, 2017

Yeah I'll do that soonish :)

@codecov-io
Copy link

codecov-io commented Nov 24, 2017

Codecov Report

Merging #2031 into master will decrease coverage by 0.24%.
The diff coverage is n/a.

Impacted file tree graph

@@            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
Impacted Files Coverage Δ
core/src/main/scala/cats/syntax/parallel.scala 57.14% <0%> (-42.86%) ⬇️
core/src/main/scala/cats/Parallel.scala 92% <0%> (-3.84%) ⬇️
core/src/main/scala/cats/Applicative.scala 80% <0%> (-3.34%) ⬇️
core/src/main/scala/cats/data/IndexedStateT.scala 98.8% <0%> (-1.2%) ⬇️
core/src/main/scala/cats/data/Kleisli.scala 97.59% <0%> (-1.18%) ⬇️
...in/scala/cats/data/IndexedReaderWriterStateT.scala 99.06% <0%> (-0.94%) ⬇️
core/src/main/scala/cats/data/WriterT.scala 93.75% <0%> (-0.94%) ⬇️
core/src/main/scala/cats/data/OptionT.scala 100% <0%> (ø) ⬆️
core/src/main/scala/cats/Foldable.scala 100% <0%> (ø) ⬆️
...ain/scala/cats/laws/discipline/FoldableTests.scala 100% <0%> (ø) ⬆️
... and 16 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9020258...61eb448. Read the comment docs.

kailuowang
kailuowang previously approved these changes Nov 24, 2017
ceedubs
ceedubs previously approved these changes Nov 27, 2017
Copy link
Contributor

@ceedubs ceedubs left a 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`.
Copy link
Contributor

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"?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done :)

@LukaJCB LukaJCB dismissed stale reviews from ceedubs and kailuowang via 61eb448 November 28, 2017 13:18
@kailuowang kailuowang merged commit b31fd06 into typelevel:master Nov 28, 2017
@kailuowang kailuowang added this to the 1.0.0 milestone Nov 28, 2017
@LukaJCB LukaJCB deleted the add-parallel-docs branch November 28, 2017 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants