-
-
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 reducible docs #1777
Add reducible docs #1777
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1777 +/- ##
=======================================
Coverage 96.09% 96.09%
=======================================
Files 273 273
Lines 4554 4554
Branches 129 122 -7
=======================================
Hits 4376 4376
Misses 178 178 Continue to review full report at Codecov.
|
2c34aea
to
8f8c764
Compare
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.
Thanks @LukaJCB! I left a couple of minor/nitpicky comments, but I'm happy with this PR being merged with or without addressing them.
`Reducible` extends the `Foldable` type class with additional `reduce` methods. | ||
|
||
You may have come by one of the `reduce`, `reduceLeft` or `reduceOption` defined in Scala's standard collections. | ||
`Reducible` offers exactly these methods with the guarantee, that the collection won't throw an exception at runtime, without having to reduce to an `Option`. |
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.
Minor: I don't think that you need a comma after "guarantee".
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 guess that years of Java have made me paranoid. Maybe "the collection won't throw an exception at runtime" is a bit of a strong guarantee. Maybe we should just say that these methods won't throw an exception due to a collection being empty? :)
Seems history got messed up? |
5d17b91
to
663186f
Compare
Fixed! |
Sorry I dropped ball on this one. @LukaJCB for some reason Github conflict merge tool is not working for us. Do yo mind update this one and merge? |
I think it's fine actually, no? You guys just need to re-review to merge :) |
Looking for some early feedback on this, still mostly unstructured :)