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 | abe384f68a8572e94acea0f3966cc72cbedd9c29 (patch) | |
| tree | c4412e9a033536d062a86a234e26b1e80d9aada0 /src/pkg/debug | |
| parent | 7d9a8fb8a913c21599959cd2cea3496ae0828bdc (diff) | |
| download | go-abe384f68a8572e94acea0f3966cc72cbedd9c29.tar.xz | |
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
Diffstat (limited to 'src/pkg/debug')
| -rw-r--r-- | src/pkg/debug/gosym/symtab.go | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/pkg/debug/gosym/symtab.go b/src/pkg/debug/gosym/symtab.go index 6a60b51e37..9ab05bac2f 100644 --- a/src/pkg/debug/gosym/symtab.go +++ b/src/pkg/debug/gosym/symtab.go @@ -34,7 +34,7 @@ type Sym struct { Func *Func } -// Static returns whether this symbol is static (not visible outside its file). +// Static reports whether this symbol is static (not visible outside its file). func (s *Sym) Static() bool { return s.Type >= 'a' } // PackageName returns the package part of the symbol name, |
