From 0354ee3aab4b65e288a24c5b4be1296ffbbfd3c3 Mon Sep 17 00:00:00 2001 From: Evan Jones Date: Tue, 31 Oct 2023 09:04:15 -0400 Subject: [PATCH] testing: correct comments on runCleanup The comment on runCleanup states "If catchPanic is true ...", but there is no catchPanic argument or variable. This was introduced in CL 214822, which introduced the panicHandling type. The code was updated during code review, but the comment was missed. Change-Id: Id14c5397e7a026bfdf98ea10ecb1e4c61ce2f924 Reviewed-on: https://go-review.googlesource.com/c/go/+/538695 Auto-Submit: Bryan Mills LUCI-TryBot-Result: Go LUCI Reviewed-by: Bryan Mills Reviewed-by: Heschi Kreinick --- src/testing/testing.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/testing/testing.go b/src/testing/testing.go index 6e277a40f9..a137fae890 100644 --- a/src/testing/testing.go +++ b/src/testing/testing.go @@ -1306,7 +1306,7 @@ func (c *common) Setenv(key, value string) { } } -// panicHanding is an argument to runCleanup. +// panicHanding controls the panic handling used by runCleanup. type panicHandling int const ( @@ -1315,8 +1315,8 @@ const ( ) // runCleanup is called at the end of the test. -// If catchPanic is true, this will catch panics, and return the recovered -// value if any. +// If ph is recoverAndReturnPanic, it will catch panics, and return the +// recovered value if any. func (c *common) runCleanup(ph panicHandling) (panicVal any) { c.cleanupStarted.Store(true) defer c.cleanupStarted.Store(false) -- 2.48.1