Enrich the scaladoc

typelevel · Dec 15, 2021 · 7fcdc26 · 7fcdc26
1 parent 97d987f
commit 7fcdc26
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/core/shared/src/main/scala/cats/effect/IO.scala b/core/shared/src/main/scala/cats/effect/IO.scala
@@ -931,6 +931,9 @@ object IO extends IOCompanionPlatform with IOLowPriorityImplicits {
 
   /**
    * Suspends a synchronous side effect in `IO`.
+   * Use [[IO.apply]] if your side effect is not thread-blocking;
+   * otherwise you should use [[IO.blocking]] or [[IO.interruptible]]
+   * depending on the need of the created effect cancelation.
    *
    * Alias for `IO.delay(body)`.
    */