Fix documentation (or design) of Free Monad
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 5.5k
- Forks
- 1.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 5
Description
Having played around with ScanamoOps I learnt that we cannot compare if two cats Free Monads are equal.
It seems it boils down to FlatMapped "case class" having a Function in it https://github.com/typelevel/cats/blob/main/free/src/main/scala/cats/free/Free.scala
That's fine, but the documentation says:
represent stateful computations as data, and run them
https://typelevel.org/cats/datatypes/freemonad.html
Please fix the documentation to say:
represent stateful computations as opaque function references, and run them
cc @stacycurl @davegurnell
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Free Monad documentation at typelevel.org/cats/datatypes/freemonad.html and compare its description with the FlatMapped case class in free/src/main/scala/cats/free/Free.scala. Update the documentation so it accurately describes computations as opaque function references, then review the page for consistent wording.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100