Merge pull request #3157 from djspiewak/feature/hide-supervisor-api

Suppress supervisor `checkRestart`
typelevel · Sep 28, 2022 · 18fb15d · 18fb15d
2 parents 6f0dea1 + 7bca9ac
commit 18fb15d
Showing 1 changed file with 4 additions and 6 deletions.
diff --git a/std/shared/src/main/scala/cats/effect/std/Supervisor.scala b/std/shared/src/main/scala/cats/effect/std/Supervisor.scala
@@ -121,13 +121,11 @@ object Supervisor {
    *   the termination policy
    *   - true - wait for the completion of the active fibers
    *   - false - cancel the active fibers
-   *
-   * @param checkRestart
-   *   An optional function which will be applied to the outcome of the child fibers when they
-   *   complete. If this function returns `true` for a given outcome, the child fiber will be
-   *   restarted. Otherwise, it will be allowed to silently terminate.
    */
-  def apply[F[_]](
+  def apply[F[_]](await: Boolean)(implicit F: Concurrent[F]): Resource[F, Supervisor[F]] =
+    apply[F](await, None)(F)
+
+  private[std] def apply[F[_]](
       await: Boolean,
       checkRestart: Option[Outcome[F, Throwable, _] => Boolean] = None)(
       implicit F: Concurrent[F]): Resource[F, Supervisor[F]] = {