From: Kir Kolyshkin <kolyshkin@gmail.com>
Date: Tue, 21 Jan 2025 01:38:26 +0000 (-0800)
Subject: testing: fix reference to B.N in docstring
X-Git-Tag: go1.24rc3~2^2~28
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=3aa7c5ef01;p=gostls13.git

testing: fix reference to B.N in docstring

Currently, a documentation reference to a struct member (such as [B.N])
does not result in it being rendered as a link, and thus the square
brackets remain in the rendered documentation which is mildly confusing.

The issue can be seen at
https://pkg.go.dev/testing@master#hdr-b_N_style_benchmarks

Remove the square brackets to fix.

Change-Id: Id374fd2085bd511018220c5d663650f89672302e
Reviewed-on: https://go-review.googlesource.com/c/go/+/643496
Reviewed-by: Ian Lance Taylor <iant@google.com>
Auto-Submit: Ian Lance Taylor <iant@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Alan Donovan <adonovan@google.com>
---

diff --git a/src/testing/testing.go b/src/testing/testing.go
index be6391b0ab..3833bfc84b 100644
--- a/src/testing/testing.go
+++ b/src/testing/testing.go
@@ -120,7 +120,7 @@
 // # b.N-style benchmarks
 //
 // Prior to the introduction of [B.Loop], benchmarks were written in a
-// different style using [B.N]. For example:
+// different style using B.N. For example:
 //
 //	func BenchmarkRandInt(b *testing.B) {
 //	    for range b.N {