Window: fix documentation

0x5a17ed · May 27, 2024 · 232db95 · 232db95
1 parent 0d450b6
commit 232db95
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/itlib/window.go b/itlib/window.go
@@ -23,7 +23,8 @@ type windowSubIterator[T any] struct{ parent *WindowIterator[T] }
 func (it windowSubIterator[T]) Next() bool { return it.parent.windowNext() }
 func (it windowSubIterator[T]) Value() T   { return it.parent.windowValue() }
 
-// WindowIterator
+// WindowIterator is an iterator providing a sliding window over the
+// given source iterator as a sub-iterator.
 type WindowIterator[T any] struct {
 	// Size specifies the window size.
 	Size uint