Merge pull request #3559 from lenguyenthanh/patch-1

mpilquist · web-flow · commit 85050d357666 · 2025-04-03T08:15:11.000-04:00
Make comment align with code for Stream.takeWhile
diff --git a/core/shared/src/main/scala/fs2/Stream.scala b/core/shared/src/main/scala/fs2/Stream.scala
@@ -2896,7 +2896,7 @@ final class Stream[+F[_], +O] private[fs2] (private[fs2] val underlying: Pull[F,
   def takeThrough(p: O => Boolean): Stream[F, O] =
     this.pull.takeThrough(p).void.stream
 
-  /** Emits the longest prefix of the input for which all elements test true according to `f`.
+  /** Emits the longest prefix of the input for which all elements test true according to `p`.
     *
     * @example {{{
     * scala> Stream.range(0,1000).takeWhile(_ != 5).toList

Original file line number	Diff line number	Diff line change
`@@ -2896,7 +2896,7 @@ final class Stream[+F[_], +O] private[fs2] (private[fs2] val underlying: Pull[F,`
`2896`	`2896`	`def takeThrough(p: O => Boolean): Stream[F, O] =`
`2897`	`2897`	`this.pull.takeThrough(p).void.stream`
`2898`	`2898`
`2899`		- /** Emits the longest prefix of the input for which all elements test true according to `f`.
	`2899`	+ /** Emits the longest prefix of the input for which all elements test true according to `p`.
`2900`	`2900`	`*`
`2901`	`2901`	`* @example {{{`
`2902`	`2902`	`* scala> Stream.range(0,1000).takeWhile(_ != 5).toList`