Skip to content

Commit

Permalink
strings: more cross-references in docstrings
Browse files Browse the repository at this point in the history
This amends CL 534775.

Change-Id: I25a217da51853ec29106998e19e9386d756902fc
Reviewed-on: https://go-review.googlesource.com/c/go/+/597655
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Carlos Amedee <carlos@golang.org>
Reviewed-by: Ian Lance Taylor <iant@google.com>
Auto-Submit: Ian Lance Taylor <iant@google.com>
  • Loading branch information
kolyshkin authored and gopherbot committed Jul 11, 2024
1 parent 08a6e08 commit 611f18c
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion src/strings/compare.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import "internal/bytealg"
// The result will be 0 if a == b, -1 if a < b, and +1 if a > b.
//
// Use Compare when you need to perform a three-way comparison (with
// slices.SortFunc, for example). It is usually clearer and always faster
// [slices.SortFunc], for example). It is usually clearer and always faster
// to use the built-in string comparison operators ==, <, >, and so on.
func Compare(a, b string) int {
return bytealg.CompareString(a, b)
Expand Down
2 changes: 1 addition & 1 deletion src/strings/replace.go
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ func makeGenericReplacer(oldnew []string) *genericReplacer {

type appendSliceWriter []byte

// Write writes to the buffer to satisfy io.Writer.
// Write writes to the buffer to satisfy [io.Writer].
func (w *appendSliceWriter) Write(p []byte) (int, error) {
*w = append(*w, p...)
return len(p), nil
Expand Down
8 changes: 4 additions & 4 deletions src/strings/strings.go
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ func IndexByte(s string, c byte) int {

// IndexRune returns the index of the first instance of the Unicode code point
// r, or -1 if rune is not present in s.
// If r is utf8.RuneError, it returns the first instance of any
// If r is [utf8.RuneError], it returns the first instance of any
// invalid UTF-8 byte sequence.
func IndexRune(s string, r rune) int {
switch {
Expand Down Expand Up @@ -275,7 +275,7 @@ func genSplit(s, sep string, sepSave, n int) []string {
// Edge cases for s and sep (for example, empty strings) are handled
// as described in the documentation for [Split].
//
// 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 string, n int) []string { return genSplit(s, sep, 0, n) }

// SplitAfterN slices s into substrings after each instance of sep and
Expand Down Expand Up @@ -304,7 +304,7 @@ func SplitAfterN(s, sep string, n int) []string {
//
// It is equivalent to [SplitN] with a count of -1.
//
// To split around the first instance of a separator, see Cut.
// To split around the first instance of a separator, see [Cut].
func Split(s, sep string) []string { return genSplit(s, sep, 0, -1) }

// SplitAfter slices s into all substrings after each instance of sep and
Expand All @@ -324,7 +324,7 @@ func SplitAfter(s, sep string) []string {
var asciiSpace = [256]uint8{'\t': 1, '\n': 1, '\v': 1, '\f': 1, '\r': 1, ' ': 1}

// Fields splits the string s around each instance of one or more consecutive white space
// characters, as defined by unicode.IsSpace, returning a slice of substrings of s or an
// characters, as defined by [unicode.IsSpace], returning a slice of substrings of s or an
// empty slice if s contains only white space.
func Fields(s string) []string {
// First count the fields.
Expand Down

0 comments on commit 611f18c

Please sign in to comment.