typelevel / typelevel/cats-effect
Add `mdoc` guards to Test Runtime documentation
Open
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 576
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 18
Description
Parts of the example code from https://typelevel.org/cats-effect/docs/core/test-runtime do not compile (h/t @lbialy).
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 Test Runtime documentation at https://typelevel.org/cats-effect/docs/core/test-runtime and check each example for compilation failures. Add the needed mdoc guards so the documented examples compile successfully, then verify the page's examples no longer produce the reported errors.
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
- 45/100