Fix wording of Filter iterator docstring

pippolo84 · pippolo84 · commit 098e423d39a6 · 2024-04-02T18:38:16.000+02:00
Filter iterator ranges over the objects and skips the ones for which the
predicate is not true.  The commit fixes the wording of the function
docstring that was stating the opposite.

Signed-off-by: Fabio Falzoi &lt;fabio.falzoi@isovalent.com&gt;
diff --git a/iterator.go b/iterator.go
@@ -76,7 +76,7 @@ func (it *mapIterator[In, Out]) Next() (out Out, revision Revision, ok bool) {
 	return
 }
 
-// Filter skips objects for which the supplied predicate returns true
+// Filter includes objects for which the supplied predicate returns true
 func Filter[Obj any, It Iterator[Obj]](iter It, pred func(Obj) bool) Iterator[Obj] {
 	return &filterIterator[Obj]{
 		iter: iter,

Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ func (it *mapIterator[In, Out]) Next() (out Out, revision Revision, ok bool) {`
`76`	`76`	`return`
`77`	`77`	`}`
`78`	`78`
`79`		`-// Filter skips objects for which the supplied predicate returns true`
	`79`	`+// Filter includes objects for which the supplied predicate returns true`
`80`	`80`	`func Filter[Obj any, It Iterator[Obj]](iter It, pred func(Obj) bool) Iterator[Obj] {`
`81`	`81`	`return &filterIterator[Obj]{`
`82`	`82`	`iter: iter,`