typelevel / typelevel/cats-effect
Document IO structured invariants
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 576
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 18
Description
In #998, several structured invariants that help us reason about the runloop more precisely were proposed. We should document these directly in IORunLoop and update them accordingly.
We should also add invariants around async computations and finalizers and the interactions between them, since we've come across several bugs there (e.g. #1045).
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 structured invariants proposed in #998 and the IORunLoop entry point. Review the async computation and finalizer interactions, including the bugs referenced in #1045, before documenting the invariants directly in IORunLoop. Done means the existing invariants are updated and the async/finalizer interactions are covered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100