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/cmd/trace | |
parent | b397248168fcb26400ac6afb88bf6080497a819e (diff) | |
download | go-9e277f7d554455e16ba3762541c53e9bfc1d8188.tar.gz go-9e277f7d554455e16ba3762541c53e9bfc1d8188.zip |
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/cmd/trace')
-rw-r--r-- | src/cmd/trace/annotations.go | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/cmd/trace/annotations.go b/src/cmd/trace/annotations.go index 2fb1198cf6..2498415681 100644 --- a/src/cmd/trace/annotations.go +++ b/src/cmd/trace/annotations.go @@ -538,7 +538,7 @@ func (task *taskDesc) overlappingInstant(ev *trace.Event) bool { return false } -// overlappingDuration returns whether the durational event, ev, overlaps with +// overlappingDuration reports whether the durational event, ev, overlaps with // any of the task's region if ev is a goroutine-local event, or overlaps with // the task's lifetime if ev is a global event. It returns the overlapping time // as well. |