Arrow: `Foldable` docs

Created on 25 Sep 2017  路  3Comments  路  Source: arrow-kt/arrow

help wanted

Most helpful comment

I'll take this if there is no problem

All 3 comments

Happy to take this if nobody is working on it

@richard-gibson Perfect! Thank you :D You can check the format we use in other typeclass docs:

  • We have a short intro mentioning what behavior they abstract, and which other typeclasses it inherits from
  • sometimes a section depicting the main use case is placed here, i.e. Applicative has a long desctiption of applicative builders
  • then go through the main combinators/operators/functions with a short description of what they can be used for. This also includes a snippet
  • afterwards we mention any piece of syntax available for the operators
  • then we have a short section mentioning that Arrow provides laws for this typeclass
  • and finally we link all the datatypes that provide an implementation of this typeclass

I'll take this if there is no problem

Was this page helpful?
0 / 5 - 0 ratings