diff options
| author | Tobias Klauser <tklauser@distanz.ch> | 2018-11-22 11:46:44 +0100 |
|---|---|---|
| committer | Tobias Klauser <tobias.klauser@gmail.com> | 2018-12-02 15:12:26 +0000 |
| commit | 9e277f7d554455e16ba3762541c53e9bfc1d8188 (patch) | |
| tree | a72e026004116edc63d3171d5d4e612ad299c265 /src/runtime/trace | |
| parent | b397248168fcb26400ac6afb88bf6080497a819e (diff) | |
| download | go-9e277f7d554455e16ba3762541c53e9bfc1d8188.tar.xz | |
all: use "reports whether" consistently instead of "returns whether"
Follow-up for CL 147037 and after Brad noticed the "returns whether"
pattern during the review of CL 150621.
Go documentation style for boolean funcs is to say:
// Foo reports whether ...
func Foo() bool
(rather than "returns whether")
Created with:
$ perl -i -npe 's/returns whether/reports whether/' $(git grep -l "returns whether" | grep -v vendor)
Change-Id: I15fe9ff99180ad97750cd05a10eceafdb12dc0b4
Reviewed-on: https://go-review.googlesource.com/c/150918
Run-TryBot: Tobias Klauser <tobias.klauser@gmail.com>
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
Diffstat (limited to 'src/runtime/trace')
| -rw-r--r-- | src/runtime/trace/annotation.go | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/runtime/trace/annotation.go b/src/runtime/trace/annotation.go index d5a7d003fe..82cb232dba 100644 --- a/src/runtime/trace/annotation.go +++ b/src/runtime/trace/annotation.go @@ -171,7 +171,7 @@ func (r *Region) End() { userRegion(r.id, regionEndCode, r.regionType) } -// IsEnabled returns whether tracing is enabled. +// IsEnabled reports whether tracing is enabled. // The information is advisory only. The tracing status // may have changed by the time this function returns. func IsEnabled() bool { |
