typelevel / typelevel/cats-effect
Add FAQ for `unused value of type cats.effect.IO[Unit] (add : Unit to discard silently)`
Open
Nobody has claimed this yet.
:books: docs
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 576
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 18
Description
This is the warning raised by the -Wnonunit-statement, at least on Scala 2 (someone should check Scala 3).
We should:
- document and recommend this very useful compiler option
- get the error into our docs, so it is indexed and searchable for when folks hit it
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 by reviewing the linked Scala and Scala 3 compiler pull requests to verify the -Wnonunit-statement warning and whether the behavior applies to both versions. Update the project documentation with a searchable FAQ entry for the cats.effect.IO[Unit] warning and recommend the compiler option; done means users can find and understand the guidance.
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