1
0
mirror of https://github.com/golang/go synced 2024-11-15 00:20:30 -07:00

testing: improve the documentation around b.N

Fixes #67137

- Make it clear the benchmark function is called multiple times.
- Demonstrate range over int.

Change-Id: I7e993d938b0351012cdd4aed8528951e0ad406ae
Reviewed-on: https://go-review.googlesource.com/c/go/+/582835
Auto-Submit: Alan Donovan <adonovan@google.com>
Reviewed-by: Alan Donovan <adonovan@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Damien Neil <dneil@google.com>
This commit is contained in:
Jorropo 2024-05-02 18:38:35 +02:00 committed by Gopher Robot
parent 660a071906
commit 865cf5c5f6

View File

@ -72,14 +72,15 @@
// A sample benchmark function looks like this:
//
// func BenchmarkRandInt(b *testing.B) {
// for i := 0; i < b.N; i++ {
// for range b.N {
// rand.Int()
// }
// }
//
// The benchmark function must run the target code b.N times.
// During benchmark execution, b.N is adjusted until the benchmark function lasts
// long enough to be timed reliably. The output
// It is called multiple times with b.N adjusted until the
// benchmark function lasts long enough to be timed reliably.
// The output
//
// BenchmarkRandInt-8 68453040 17.8 ns/op
//
@ -91,7 +92,7 @@
// func BenchmarkBigLen(b *testing.B) {
// big := NewBig()
// b.ResetTimer()
// for i := 0; i < b.N; i++ {
// for range b.N {
// big.Len()
// }
// }