1
0
mirror of https://github.com/golang/go synced 2024-09-30 18:28:32 -06:00
go/doc/play
Rob Pike abe384f68a 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
2013-07-23 11:59:49 +10:00
..
fib.go doc/play: don't use println in examples 2012-11-26 13:05:18 -08:00
hello.go cmd/godoc: add toys, tour button to playground 2012-03-15 17:44:47 +11:00
life.go all: be more idiomatic when documenting boolean return values. 2013-07-23 11:59:49 +10:00
peano.go cmd/godoc: add toys, tour button to playground 2012-03-15 17:44:47 +11:00
pi.go cmd/godoc: add toys, tour button to playground 2012-03-15 17:44:47 +11:00
playground.js doc: update playground.js 2013-07-04 14:24:21 +10:00
sieve.go doc/play: don't use println in examples 2012-11-26 13:05:18 -08:00
solitaire.go doc/play: don't use println in examples 2012-11-26 13:05:18 -08:00
tree.go doc/play: don't use println in examples 2012-11-26 13:05:18 -08:00