From: Evan Jones <ej@evanjones.ca>
Date: Tue, 31 Oct 2023 13:04:15 +0000 (-0400)
Subject: testing: correct comments on runCleanup
X-Git-Tag: go1.22rc1~427
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=0354ee3aab4b65e288a24c5b4be1296ffbbfd3c3;p=gostls13.git

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 <bcmills@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Bryan Mills <bcmills@google.com>
Reviewed-by: Heschi Kreinick <heschi@google.com>
---

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)