Hierarchy of cats effect in Cats documentation does not match the one in the cats effect docs
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 5.5k
- Forks
- 1.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 5
Description
The picture under the text "Type classes in Cats" here: https://github.com/typelevel/cats/blob/main/docs/typeclasses.md
seems to suggest that Concurrent is a subclass of Async, but here:
https://typelevel.org/cats-effect/docs/typeclasses
exactly the opposite is suggested. Looking at the actual code suggests that the documentation in Cats is incorrect.
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 docs/typeclasses.md and inspect the picture under “Type classes in Cats.” Compare its hierarchy with the Cats Effect typeclasses documentation and the actual Cats code referenced by the issue. Done means the Cats documentation diagram accurately reflects the implemented relationship between Concurrent and Async.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100