]> Cypherpunks repositories - gostls13.git/commit
strings: add note for new Go developers to TrimLeft and TrimRight
authorDaniel Martí <mvdan@mvdan.cc>
Fri, 29 Jun 2018 16:46:17 +0000 (17:46 +0100)
committerBrad Fitzpatrick <bradfitz@golang.org>
Fri, 29 Jun 2018 16:57:32 +0000 (16:57 +0000)
commit62d270e0a424dddd54571a6a119fc4e3d4b1b901
tree9373625de5eaa403c1a3661a93f566b105824856
parent57da8dd459e705888c4c49a487df5f6d58eb6877
strings: add note for new Go developers to TrimLeft and TrimRight

If one quickly looks at the strings package godoc, reading the name
TrimLeft, one might think it removes a prefix from the string.

The function's godoc does explain its purpose, but it's apparent that it
is not clear enough, as there have been numerous raised issues about
this confusion: #12771 #14657 #18160 #19371 #20085 #25328 #26119. These
questions are also frequent elsewhere on the internet.

Add a very short paragraph to the godoc, to hopefully point new Go
developers in the right direction faster. Do the same thing for
TrimRight and TrimSuffix.

Change-Id: I4dee5ed8dd9fba565b4755bad12ae1ee6d277959
Reviewed-on: https://go-review.googlesource.com/121637
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
src/strings/strings.go