Merge pull request #3569 from typelevel/sam/chunkN-doc-clarification

mpilquist · web-flow · commit 80be399b2f46 · 2025-05-09T07:11:58.000-04:00
clarify chunkN doc about allowFewer
diff --git a/core/shared/src/main/scala/fs2/Stream.scala b/core/shared/src/main/scala/fs2/Stream.scala
@@ -446,7 +446,7 @@ final class Stream[+F[_], +O] private[fs2] (private[fs2] val underlying: Pull[F,
   /** Outputs chunks of size `n`.
     *
     * Chunks from the source stream are split as necessary.
-    * If `allowFewer` is true, the last chunk that is emitted may have less than `n` elements.
+    * If `allowFewer` is true, the last chunk that is emitted, upon completion of the stream, may have fewer than `n` elements.
     *
     * Note: the emitted chunk may be a composite chunk (i.e., an instance of `Chunk.Queue`) and
     * hence may not have O(1) lookup by index. Consider calling `.map(_.compact)` if indexed

Original file line number	Diff line number	Diff line change
`@@ -446,7 +446,7 @@ final class Stream[+F[_], +O] private[fs2] (private[fs2] val underlying: Pull[F,`
`446`	`446`	/** Outputs chunks of size `n`.
`447`	`447`	`*`
`448`	`448`	`* Chunks from the source stream are split as necessary.`
`449`		- * If `allowFewer` is true, the last chunk that is emitted may have less than `n` elements.
	`449`	+ * If `allowFewer` is true, the last chunk that is emitted, upon completion of the stream, may have fewer than `n` elements.
`450`	`450`	`*`
`451`	`451`	* Note: the emitted chunk may be a composite chunk (i.e., an instance of `Chunk.Queue`) and
`452`	`452`	* hence may not have O(1) lookup by index. Consider calling `.map(_.compact)` if indexed