1
0
mirror of https://github.com/golang/go synced 2024-11-18 18:54:42 -07:00
go/godoc
Rob Pike 9ac8940d29 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.

R=golang-dev, dsymonds
CC=golang-dev
https://golang.org/cl/11458046
2013-07-23 10:37:43 +10:00
..
util all: be more idiomatic when documenting boolean return values. 2013-07-23 10:37:43 +10:00
vfs godoc: more cleanup 2013-07-18 13:51:17 +10:00
corpus.go godoc: remove the last of the global variables, unexport Server 2013-07-19 10:27:53 +10:00
dirtrees.go godoc: remove more global variables 2013-07-18 13:14:09 +10:00
format.go godoc: move bulk of the code to the package 2013-07-17 17:09:54 +10:00
godoc.go godoc: remove the last of the global variables, unexport Server 2013-07-19 10:27:53 +10:00
index.go godoc: remove the last of the global variables, unexport Server 2013-07-19 10:27:53 +10:00
linkify.go godoc: remove the last of the global variables, unexport Server 2013-07-19 10:27:53 +10:00
meta.go godoc: remove more global variables 2013-07-18 13:14:09 +10:00
page.go godoc: more cleanup 2013-07-18 13:51:17 +10:00
parser.go godoc: remove more global variables 2013-07-18 13:14:09 +10:00
pres.go godoc: move search from cmd to the package 2013-07-19 14:02:03 +10:00
search.go godoc: move search from cmd to the package 2013-07-19 14:02:03 +10:00
server.go godoc: move search from cmd to the package 2013-07-19 14:02:03 +10:00
snippet.go godoc: remove more global variables 2013-07-18 13:14:09 +10:00
spec.go godoc: move bulk of the code to the package 2013-07-17 17:09:54 +10:00
spot.go godoc: actually include files from previous CL 2013-07-17 17:17:12 +10:00
tab.go godoc: remove more global variables 2013-07-18 13:14:09 +10:00
template.go godoc: remove more global variables 2013-07-18 13:14:09 +10:00