all: be more idiomatic when documenting boolean return values.

Phrases like "returns whether or not the image is opaque" could be
describing what the function does (it always returns, regardless of
the opacity) or what it returns (a boolean indicating the opacity).
Even when the "or not" is missing, the phrasing is bizarre.

Go with "reports whether", which is still clunky but at least makes
it clear we're talking about the return value.

These were edited by hand. A few were cleaned up in other ways.

R=golang-dev, dsymonds
CC=golang-dev
https://golang.org/cl/11699043
This commit is contained in:
Rob Pike 2013-07-23 11:59:49 +10:00
parent 7d9a8fb8a9
commit abe384f68a
45 changed files with 92 additions and 92 deletions

View file

@ -77,7 +77,7 @@ func Count(s, sep []byte) int {
return count
}
// Contains returns whether subslice is within b.
// Contains reports whether subslice is within b.
func Contains(b, subslice []byte) bool {
return Index(b, subslice) != -1
}