From 35c0ea22a94aa5ad447bf640c4f7388d3f1d75eb Mon Sep 17 00:00:00 2001 From: Cherry Mui Date: Fri, 7 Feb 2025 17:42:02 -0500 Subject: [PATCH] [release-branch.go1.24] bytes: use "subslice" instead of "substring" in doc comments The bytes package iterators return subslices, not substrings. Updates #61901. Change-Id: Ida91d3e33a0f178edfe9a267861adf4f13f9a965 Reviewed-on: https://go-review.googlesource.com/c/go/+/647875 Reviewed-by: Ian Lance Taylor LUCI-TryBot-Result: Go LUCI (cherry picked from commit ff27d270c9f95178f9749bc8e1f15957b1c1d5b3) Reviewed-on: https://go-review.googlesource.com/c/go/+/648095 Reviewed-by: Dmitri Shuralyov Reviewed-by: Dmitri Shuralyov TryBot-Bypass: Cherry Mui --- src/bytes/iter.go | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/src/bytes/iter.go b/src/bytes/iter.go index 9890a478a8..799602d9e3 100644 --- a/src/bytes/iter.go +++ b/src/bytes/iter.go @@ -67,26 +67,26 @@ func splitSeq(s, sep []byte, sepSave int) iter.Seq[[]byte] { } } -// SplitSeq returns an iterator over all substrings of s separated by sep. -// The iterator yields the same strings that would be returned by [Split](s, sep), -// but without constructing the slice. +// SplitSeq returns an iterator over all subslices of s separated by sep. +// The iterator yields the same subslices that would be returned by [Split](s, sep), +// but without constructing a new slice containing the subslices. // It returns a single-use iterator. func SplitSeq(s, sep []byte) iter.Seq[[]byte] { return splitSeq(s, sep, 0) } -// SplitAfterSeq returns an iterator over substrings of s split after each instance of sep. -// The iterator yields the same strings that would be returned by [SplitAfter](s, sep), -// but without constructing the slice. +// SplitAfterSeq returns an iterator over subslices of s split after each instance of sep. +// The iterator yields the same subslices that would be returned by [SplitAfter](s, sep), +// but without constructing a new slice containing the subslices. // It returns a single-use iterator. func SplitAfterSeq(s, sep []byte) iter.Seq[[]byte] { return splitSeq(s, sep, len(sep)) } -// FieldsSeq returns an iterator over substrings of s split around runs of +// FieldsSeq returns an iterator over subslices of s split around runs of // whitespace characters, as defined by [unicode.IsSpace]. -// The iterator yields the same strings that would be returned by [Fields](s), -// but without constructing the slice. +// The iterator yields the same subslices that would be returned by [Fields](s), +// but without constructing a new slice containing the subslices. func FieldsSeq(s []byte) iter.Seq[[]byte] { return func(yield func([]byte) bool) { start := -1 @@ -116,10 +116,10 @@ func FieldsSeq(s []byte) iter.Seq[[]byte] { } } -// FieldsFuncSeq returns an iterator over substrings of s split around runs of +// FieldsFuncSeq returns an iterator over subslices of s split around runs of // Unicode code points satisfying f(c). -// The iterator yields the same strings that would be returned by [FieldsFunc](s), -// but without constructing the slice. +// The iterator yields the same subslices that would be returned by [FieldsFunc](s), +// but without constructing a new slice containing the subslices. func FieldsFuncSeq(s []byte, f func(rune) bool) iter.Seq[[]byte] { return func(yield func([]byte) bool) { start := -1 -- 2.48.1