document GroupedWithin

lichess-org · Sep 20, 2024 · 26e98dc · 26e98dc
1 parent 20832c4
commit 26e98dc
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/main/scala/util/GroupedWithin.scala b/src/main/scala/util/GroupedWithin.scala
@@ -6,6 +6,9 @@ import org.apache.pekko.actor.typed.Scheduler
 
 import scala.collection.immutable.VectorBuilder
 
+/** Group elements into a fixed-sized buffer. The elements are emitted when the buffer is full, or
+  * periodically after a fixed time interval.
+  */
 final class GroupedWithin()(using Scheduler, Executor):
 
   def apply[A](nb: Int, interval: FiniteDuration)(emit: Emit[Vector[A]]) =