]> Cypherpunks.ru repositories - gostls13.git/commit
all: use "reports whether" consistently in the few places that didn't
authorBrad Fitzpatrick <bradfitz@golang.org>
Fri, 2 Nov 2018 15:18:43 +0000 (15:18 +0000)
committerBrad Fitzpatrick <bradfitz@golang.org>
Fri, 2 Nov 2018 22:47:58 +0000 (22:47 +0000)
commit3813edf26edb78620632dc9c7d66096e5b2b5019
tree7b61738f970909800472f3ab5d00e90ddd0d405e
parente25823edcea364df70b8db7462f53e7dac2b8fca
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>
47 files changed:
src/cmd/asm/internal/lex/input.go
src/cmd/compile/internal/gc/closure.go
src/cmd/compile/internal/gc/syntax.go
src/cmd/compile/internal/ssa/config.go
src/cmd/compile/internal/ssa/debug.go
src/cmd/compile/internal/ssa/func.go
src/cmd/compile/internal/ssa/gen/genericOps.go
src/cmd/compile/internal/ssa/gen/rulegen.go
src/cmd/compile/internal/ssa/poset.go
src/cmd/compile/internal/ssa/rewrite.go
src/cmd/compile/internal/ssa/trim.go
src/cmd/fix/fix.go
src/cmd/internal/dwarf/dwarf.go
src/cmd/trace/annotations.go
src/cmd/vet/print.go
src/crypto/x509/x509.go
src/database/sql/sql.go
src/encoding/asn1/asn1.go
src/go/printer/nodes.go
src/go/types/builtins.go
src/go/types/scope.go
src/go/types/type.go
src/html/template/js.go
src/html/template/url.go
src/internal/poll/fd_plan9.go
src/internal/poll/fd_poll_nacljs.go
src/internal/poll/fd_poll_runtime.go
src/math/big/float.go
src/math/cmplx/isinf.go
src/math/cmplx/isnan.go
src/math/signbit.go
src/os/stat_windows.go
src/path/filepath/match_test.go
src/reflect/type.go
src/regexp/syntax/regexp.go
src/runtime/mbitmap.go
src/runtime/mcentral.go
src/runtime/mgc.go
src/runtime/mgcwork.go
src/runtime/mwbbuf.go
src/runtime/netpoll.go
src/runtime/panic.go
src/runtime/pprof/internal/profile/profile.go
src/runtime/proc.go
src/runtime/signal_windows.go
src/sync/runtime.go
src/syscall/mksyscall_windows.go