Merge pull request #3225 from djspiewak/feature/foldstep

Publicize Free#foldStep
typelevel · Dec 31, 2019 · 371fe73 · 371fe73
2 parents f44f251 + e814bf7
commit 371fe73
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/free/src/main/scala/cats/free/Free.scala b/free/src/main/scala/cats/free/Free.scala
@@ -70,9 +70,10 @@ sealed abstract class Free[S[_], A] extends Product with Serializable {
   }
 
   /**
-   * A combination of step and fold.
+   * A combination of step and fold. May be used to define interpreters with custom
+   * (non-monoidial) control flow.
    */
-  final private[free] def foldStep[B](
+  final def foldStep[B](
     onPure: A => B,
     onSuspend: S[A] => B,
     onFlatMapped: ((S[X], X => Free[S, A]) forSome { type X }) => B