diff options
| author | Rob Pike <r@golang.org> | 2013-07-23 11:59:49 +1000 |
|---|---|---|
| committer | Rob Pike <r@golang.org> | 2013-07-23 11:59:49 +1000 |
| commit | c13c56605db83bd775736616f9e19837b93ede97 (patch) | |
| tree | 566fc71200824838df66c0dc4203e42e2c2901de /src/pkg/net/http/request.go | |
| parent | e8ee29cd4005834559698014a75e0692cbce351f (diff) | |
| download | go-c13c56605db83bd775736616f9e19837b93ede97.tar.gz | |
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://codereview.appspot.com/11699043
Diffstat (limited to 'src/pkg/net/http/request.go')
| -rw-r--r-- | src/pkg/net/http/request.go | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/pkg/net/http/request.go b/src/pkg/net/http/request.go index 3b29aefcd..14cc42f53 100644 --- a/src/pkg/net/http/request.go +++ b/src/pkg/net/http/request.go @@ -183,7 +183,7 @@ type Request struct { TLS *tls.ConnectionState } -// ProtoAtLeast returns whether the HTTP protocol used +// ProtoAtLeast reports whether the HTTP protocol used // in the request is at least major.minor. func (r *Request) ProtoAtLeast(major, minor int) bool { return r.ProtoMajor > major || |