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/cmd/gc/subr.c | |
| 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/cmd/gc/subr.c')
| -rw-r--r-- | src/cmd/gc/subr.c | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/cmd/gc/subr.c b/src/cmd/gc/subr.c index 3b1b0543e..d828c784b 100644 --- a/src/cmd/gc/subr.c +++ b/src/cmd/gc/subr.c @@ -525,7 +525,7 @@ saveorignode(Node *n) n->orig = norig; } -// ispaddedfield returns whether the given field +// ispaddedfield reports whether the given field // is followed by padding. For the case where t is // the last field, total gives the size of the enclosing struct. static int |