strings: document that NewReplacer can panic

Fixes #31233

Change-Id: I2831d5e6532d3f4ed7eb99af5d6e0e1a41ebac9a
Reviewed-on: https://go-review.googlesource.com/c/go/+/170624
Reviewed-by: Andrew Bonventre <andybons@golang.org>

diff --git a/src/strings/replace.go b/src/strings/replace.go
index ace0b8d646e38493d836e5d4b46ee09a78d4be69..ccab1fb861d3b3b07406b1f86a57931f5419f2ce 100644 (file)
--- a/src/strings/replace.go
+++ b/src/strings/replace.go
@@ -26,6 +26,8 @@ type replacer interface {
 // NewReplacer returns a new Replacer from a list of old, new string
 // pairs. Replacements are performed in the order they appear in the
 // target string, without overlapping matches.
+//
+// NewReplacer panics if given an odd number of arguments.
 func NewReplacer(oldnew ...string) *Replacer {
        if len(oldnew)%2 == 1 {
                panic("strings.NewReplacer: odd argument count")