From b0927fdd494a79458ff151ce8db59963f67b80be Mon Sep 17 00:00:00 2001 From: Jes Cok Date: Fri, 28 Jun 2024 00:00:00 +0800 Subject: [PATCH] slices: update docs for All, Backward, Values For #61899 Change-Id: I3586b9b59e87159d21e1a270dabb3af213592739 Reviewed-on: https://go-review.googlesource.com/c/go/+/595515 Auto-Submit: Ian Lance Taylor LUCI-TryBot-Result: Go LUCI Reviewed-by: Alan Donovan Reviewed-by: Ian Lance Taylor --- src/slices/iter.go | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/src/slices/iter.go b/src/slices/iter.go index 131cece3a0..cd8f308ca0 100644 --- a/src/slices/iter.go +++ b/src/slices/iter.go @@ -9,8 +9,8 @@ import ( "iter" ) -// All returns an iterator over index-value pairs in the slice. -// The indexes range in the usual order, from 0 through len(s)-1. +// All returns an iterator over index-value pairs in the slice +// in the usual order. func All[Slice ~[]E, E any](s Slice) iter.Seq2[int, E] { return func(yield func(int, E) bool) { for i, v := range s { @@ -22,7 +22,7 @@ func All[Slice ~[]E, E any](s Slice) iter.Seq2[int, E] { } // Backward returns an iterator over index-value pairs in the slice, -// traversing it backward. The indexes range from len(s)-1 down to 0. +// traversing it backward with descending indices. func Backward[Slice ~[]E, E any](s Slice) iter.Seq2[int, E] { return func(yield func(int, E) bool) { for i := len(s) - 1; i >= 0; i-- { @@ -33,8 +33,7 @@ func Backward[Slice ~[]E, E any](s Slice) iter.Seq2[int, E] { } } -// Values returns an iterator over the slice elements, -// starting with s[0]. +// Values returns an iterator that yields the slice elements in order. func Values[Slice ~[]E, E any](s Slice) iter.Seq[E] { return func(yield func(E) bool) { for _, v := range s {