typelevel / typelevel/cats-effect
Emphasize programs-as-values in the documentation
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 576
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 18
Description
Following an extensive discord discussion, it seems we can be better at teaching the program-as-values paradigm in the Cats Effect documentation, and that this should be given priority over concurrency concepts (which presumably build on that knowledge anyway).
Personally, it hadn't really struck me until that discussion that without an appreciation for flatMap and friends, it can feel like the only way to get an A out of IO[A] and compose programs is by calling an unsafeRun* method.
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
No documentation file or test is named. Start by locating the Cats Effect documentation sections covering concurrency and program composition, then review how IO[A], flatMap, and unsafeRun* are introduced. Done means the documentation clearly teaches programs as values before relying on concurrency concepts.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100