bytes, strings: mention Cut in docs for Split and SplitN

For #46336

Change-Id: Idc23302085e14e24d571f5995d6d33ca964a0021
Reviewed-on: https://go-review.googlesource.com/c/go/+/382954
Trust: Ian Lance Taylor <iant@golang.org>
Run-TryBot: Ian Lance Taylor <iant@golang.org>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Russ Cox <rsc@golang.org>
This commit is contained in:
Ian Lance Taylor 2022-02-03 12:13:00 -08:00
parent 3e514a0103
commit 540632841e
2 changed files with 8 additions and 0 deletions

View file

@ -372,6 +372,8 @@ func genSplit(s, sep []byte, sepSave, n int) [][]byte {
// n > 0: at most n subslices; the last subslice will be the unsplit remainder. // n > 0: at most n subslices; the last subslice will be the unsplit remainder.
// n == 0: the result is nil (zero subslices) // n == 0: the result is nil (zero subslices)
// n < 0: all subslices // n < 0: all subslices
//
// To split around the first instance of a separator, see Cut.
func SplitN(s, sep []byte, n int) [][]byte { return genSplit(s, sep, 0, n) } func SplitN(s, sep []byte, n int) [][]byte { return genSplit(s, sep, 0, n) }
// SplitAfterN slices s into subslices after each instance of sep and // SplitAfterN slices s into subslices after each instance of sep and
@ -389,6 +391,8 @@ func SplitAfterN(s, sep []byte, n int) [][]byte {
// the subslices between those separators. // the subslices between those separators.
// If sep is empty, Split splits after each UTF-8 sequence. // If sep is empty, Split splits after each UTF-8 sequence.
// It is equivalent to SplitN with a count of -1. // It is equivalent to SplitN with a count of -1.
//
// To split around the first instance of a separator, see Cut.
func Split(s, sep []byte) [][]byte { return genSplit(s, sep, 0, -1) } func Split(s, sep []byte) [][]byte { return genSplit(s, sep, 0, -1) }
// SplitAfter slices s into all subslices after each instance of sep and // SplitAfter slices s into all subslices after each instance of sep and

View file

@ -270,6 +270,8 @@ func genSplit(s, sep string, sepSave, n int) []string {
// //
// Edge cases for s and sep (for example, empty strings) are handled // Edge cases for s and sep (for example, empty strings) are handled
// as described in the documentation for Split. // as described in the documentation for Split.
//
// To split around the first instance of a separator, see Cut.
func SplitN(s, sep string, n int) []string { return genSplit(s, sep, 0, n) } func SplitN(s, sep string, n int) []string { return genSplit(s, sep, 0, n) }
// SplitAfterN slices s into substrings after each instance of sep and // SplitAfterN slices s into substrings after each instance of sep and
@ -296,6 +298,8 @@ func SplitAfterN(s, sep string, n int) []string {
// and sep are empty, Split returns an empty slice. // and sep are empty, Split returns an empty slice.
// //
// It is equivalent to SplitN with a count of -1. // It is equivalent to SplitN with a count of -1.
//
// To split around the first instance of a separator, see Cut.
func Split(s, sep string) []string { return genSplit(s, sep, 0, -1) } func Split(s, sep string) []string { return genSplit(s, sep, 0, -1) }
// SplitAfter slices s into all substrings after each instance of sep and // SplitAfter slices s into all substrings after each instance of sep and