mirror of
https://github.com/golang/go
synced 2024-11-26 15:46:54 -07:00
strings,bytes,regexp: use lists in Split* docstrings
This looks better than the default of using a code block. While at it, fix punctuation. Change-Id: I86abca4da1e9999b7e9043e615ad0988d35a5a46 Reviewed-on: https://go-review.googlesource.com/c/go/+/597656 Reviewed-by: Cherry Mui <cherryyz@google.com> Reviewed-by: Ian Lance Taylor <iant@google.com> Auto-Submit: Ian Lance Taylor <iant@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
This commit is contained in:
parent
b4a92f56ff
commit
451a284d80
@ -355,10 +355,9 @@ func genSplit(s, sep []byte, sepSave, n int) [][]byte {
|
|||||||
// the subslices between those separators.
|
// the subslices between those separators.
|
||||||
// If sep is empty, SplitN splits after each UTF-8 sequence.
|
// If sep is empty, SplitN splits after each UTF-8 sequence.
|
||||||
// The count determines the number of subslices to return:
|
// The count determines the number of subslices to return:
|
||||||
//
|
// - 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.
|
// 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) }
|
||||||
@ -367,10 +366,9 @@ func SplitN(s, sep []byte, n int) [][]byte { return genSplit(s, sep, 0, n) }
|
|||||||
// returns a slice of those subslices.
|
// returns a slice of those subslices.
|
||||||
// If sep is empty, SplitAfterN splits after each UTF-8 sequence.
|
// If sep is empty, SplitAfterN splits after each UTF-8 sequence.
|
||||||
// The count determines the number of subslices to return:
|
// The count determines the number of subslices to return:
|
||||||
//
|
// - 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
|
|
||||||
func SplitAfterN(s, sep []byte, n int) [][]byte {
|
func SplitAfterN(s, sep []byte, n int) [][]byte {
|
||||||
return genSplit(s, sep, len(sep), n)
|
return genSplit(s, sep, len(sep), n)
|
||||||
}
|
}
|
||||||
|
@ -1244,10 +1244,9 @@ func (re *Regexp) FindAllStringSubmatchIndex(s string, n int) [][]int {
|
|||||||
// // s: ["", "b", "b", "c", "cadaaae"]
|
// // s: ["", "b", "b", "c", "cadaaae"]
|
||||||
//
|
//
|
||||||
// The count determines the number of substrings to return:
|
// The count determines the number of substrings to return:
|
||||||
//
|
// - n > 0: at most n substrings; the last substring will be the unsplit remainder;
|
||||||
// n > 0: at most n substrings; the last substring will be the unsplit remainder.
|
// - n == 0: the result is nil (zero substrings);
|
||||||
// n == 0: the result is nil (zero substrings)
|
// - n < 0: all substrings.
|
||||||
// n < 0: all substrings
|
|
||||||
func (re *Regexp) Split(s string, n int) []string {
|
func (re *Regexp) Split(s string, n int) []string {
|
||||||
|
|
||||||
if n == 0 {
|
if n == 0 {
|
||||||
|
@ -267,10 +267,9 @@ func genSplit(s, sep string, sepSave, n int) []string {
|
|||||||
// the substrings between those separators.
|
// the substrings between those separators.
|
||||||
//
|
//
|
||||||
// The count determines the number of substrings to return:
|
// The count determines the number of substrings to return:
|
||||||
//
|
// - n > 0: at most n substrings; the last substring will be the unsplit remainder;
|
||||||
// n > 0: at most n substrings; the last substring will be the unsplit remainder.
|
// - n == 0: the result is nil (zero substrings);
|
||||||
// n == 0: the result is nil (zero substrings)
|
// - n < 0: all substrings.
|
||||||
// n < 0: all substrings
|
|
||||||
//
|
//
|
||||||
// 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].
|
||||||
@ -282,10 +281,9 @@ func SplitN(s, sep string, n int) []string { return genSplit(s, sep, 0, n) }
|
|||||||
// returns a slice of those substrings.
|
// returns a slice of those substrings.
|
||||||
//
|
//
|
||||||
// The count determines the number of substrings to return:
|
// The count determines the number of substrings to return:
|
||||||
//
|
// - n > 0: at most n substrings; the last substring will be the unsplit remainder;
|
||||||
// n > 0: at most n substrings; the last substring will be the unsplit remainder.
|
// - n == 0: the result is nil (zero substrings);
|
||||||
// n == 0: the result is nil (zero substrings)
|
// - n < 0: all substrings.
|
||||||
// n < 0: all substrings
|
|
||||||
//
|
//
|
||||||
// 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 SplitAfter.
|
// as described in the documentation for SplitAfter.
|
||||||
|
Loading…
Reference in New Issue
Block a user