]> Cypherpunks repositories - gostls13.git/commit
all: be more idiomatic when documenting boolean return values.
authorRob Pike <r@golang.org>
Tue, 23 Jul 2013 01:59:49 +0000 (11:59 +1000)
committerRob Pike <r@golang.org>
Tue, 23 Jul 2013 01:59:49 +0000 (11:59 +1000)
commitabe384f68a8572e94acea0f3966cc72cbedd9c29
treec4412e9a033536d062a86a234e26b1e80d9aada0
parent7d9a8fb8a913c21599959cd2cea3496ae0828bdc
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
45 files changed:
doc/play/life.go
src/cmd/dist/plan9.c
src/cmd/dist/unix.c
src/cmd/dist/windows.c
src/cmd/gc/export.c
src/cmd/gc/subr.c
src/cmd/go/pkg.go
src/pkg/bufio/scan.go
src/pkg/bytes/bytes.go
src/pkg/crypto/ecdsa/ecdsa.go
src/pkg/crypto/x509/pkix/pkix.go
src/pkg/debug/gosym/symtab.go
src/pkg/encoding/asn1/asn1.go
src/pkg/encoding/gob/encode.go
src/pkg/encoding/json/tags.go
src/pkg/flag/flag.go
src/pkg/fmt/print.go
src/pkg/go/ast/ast.go
src/pkg/go/doc/testdata/testing.0.golden
src/pkg/go/doc/testdata/testing.1.golden
src/pkg/go/doc/testdata/testing.2.golden
src/pkg/go/doc/testdata/testing.go
src/pkg/html/template/context.go
src/pkg/html/template/css.go
src/pkg/html/template/escape.go
src/pkg/html/template/js.go
src/pkg/html/template/transition.go
src/pkg/image/format.go
src/pkg/image/geom.go
src/pkg/image/image.go
src/pkg/image/jpeg/dct_test.go
src/pkg/image/names.go
src/pkg/math/bits.go
src/pkg/mime/multipart/multipart.go
src/pkg/net/http/cookiejar/jar.go
src/pkg/net/http/header.go
src/pkg/net/http/request.go
src/pkg/net/http/response.go
src/pkg/net/http/server.go
src/pkg/net/http/transfer.go
src/pkg/os/doc.go
src/pkg/os/error.go
src/pkg/regexp/regexp.go
src/pkg/sort/sort.go
src/pkg/text/template/exec.go