Add FAQ for `unused value of type cats.effect.IO[Unit] (add : Unit to discard silently)`

typelevel / cats-effect

The pure asynchronous runtime for Scala

https://typelevel.org/cats-effect/

Apache License 2.0

1.99k stars 511 forks source link

Open armanbilge opened 1 year ago

armanbilge commented 1 year ago

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

froth commented 3 months ago

questions / thoughts before I invest time in this:

should the recommendation the compiler option in getting-started? I would think so, because in FAQ it will get overlooked to easily.
Adding something to FAQ additionally would be a good idea for more clarification and indexing the error
Do we want to recommend/mention typelevel/sbt-tpolecat pending fix for https://github.com/typelevel/sbt-tpolecat/issues/208 ?