-
-
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 some basic docs for Foldable #473
Conversation
Could you add a section on a the monoid for product/tuple types? Not sure if you should put it on Foldable or Monoid or both (maybe mention it in Monoid and then give an example in Foldable) - its fairly common (esp. in data processing contexts) to be able to compute multiple "summary" values over a large set of data in a single pass (think streaming data). |
This is great, thanks! I have an ask which is smaller than @adelbertc's: we should make sure to point out that the built-in signature of That all said, I'm also happy to merge this now and then update the document in future PRs. 👍 |
048ff5e
to
7c14881
Compare
Current coverage is
|
👍 I'd be happy to merge this now and expand on it later. Thanks @philwills! |
Could you replace "typeclass" with "type class" since we have recently agreed on that spelling (#441). Other than that, LGTMT and I'm also fine with merging it now. |
It looks like this PR includes the same monoid doc that is in #460. Is that an accident? It would probably be good to add some clarification that "Right" vs "Left" is really about association as opposed to starting at the end vs beginning of the data structure. That is, we can implement |
7c14881
to
4290065
Compare
As requested by @non
Thanks for the heads up @fthomas
The Travis error is unrelated. I can't speak for the CSS change, but the rest looks good to me. |
@adelbertc's comment in #460 made me realise that Foldable doesn't currently have any docs.
Once again, these are largely based off the Scaladoc, with a few examples added.
This was based on the branch for #460, but if for some reason, you don't want that and do want this, I'm happy to rebase.