diff options
author | Brad Fitzpatrick <bradfitz@golang.org> | 2018-11-02 15:18:43 +0000 |
---|---|---|
committer | Brad Fitzpatrick <bradfitz@golang.org> | 2018-11-02 22:47:58 +0000 |
commit | 3813edf26edb78620632dc9c7d66096e5b2b5019 (patch) | |
tree | 7b61738f970909800472f3ab5d00e90ddd0d405e /src/sync | |
parent | e25823edcea364df70b8db7462f53e7dac2b8fca (diff) | |
download | go-3813edf26edb78620632dc9c7d66096e5b2b5019.tar.gz go-3813edf26edb78620632dc9c7d66096e5b2b5019.zip |
all: use "reports whether" consistently in the few places that didn't
Go documentation style for boolean funcs is to say:
// Foo reports whether ...
func Foo() bool
(rather than "returns true if")
This CL also replaces 4 uses of "iff" with the same "reports whether"
wording, which doesn't lose any meaning, and will prevent people from
sending typo fixes when they don't realize it's "if and only if". In
the past I think we've had the typo CLs updated to just say "reports
whether". So do them all at once.
(Inspired by the addition of another "returns true if" in CL 146938
in fd_plan9.go)
Created with:
$ perl -i -npe 's/returns true if/reports whether/' $(git grep -l "returns true iff" | grep -v vendor)
$ perl -i -npe 's/returns true if/reports whether/' $(git grep -l "returns true if" | grep -v vendor)
Change-Id: Ided502237f5ab0d25cb625dbab12529c361a8b9f
Reviewed-on: https://go-review.googlesource.com/c/147037
Reviewed-by: Ian Lance Taylor <iant@golang.org>
Diffstat (limited to 'src/sync')
-rw-r--r-- | src/sync/runtime.go | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/sync/runtime.go b/src/sync/runtime.go index a13d9f6cf1..b6b9e480a4 100644 --- a/src/sync/runtime.go +++ b/src/sync/runtime.go @@ -54,7 +54,7 @@ func init() { } // Active spinning runtime support. -// runtime_canSpin returns true if spinning makes sense at the moment. +// runtime_canSpin reports whether spinning makes sense at the moment. func runtime_canSpin(i int) bool // runtime_doSpin does active spinning. |