Skip to content

Commit 32afbca

Browse files
committed
Improvements to comments thanks to review
1 parent da8d23f commit 32afbca

2 files changed

Lines changed: 5 additions & 4 deletions

File tree

include/benchmark/benchmark.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1206,9 +1206,9 @@ class BENCHMARK_EXPORT Benchmark {
12061206
// Set the minimum relative accuracy to use to determine the required number
12071207
// of iterations when running this benchmark. This option overrides
12081208
// the `benchmark_min_rel_accuracy` flag.
1209-
// REQUIRES: `t > 0`, `Iterations` has not been called on this benchmark, and
1209+
// REQUIRES: `r > 0`, `Iterations` has not been called on this benchmark, and
12101210
// time is measured manually, i.e., `UseManualTime` has been called on this
1211-
// benchmark and each benchmark iteration should call SetIterationTime(seconds)
1211+
// benchmark and each benchmark iteration should call `SetIterationTime(seconds)`
12121212
// to report the measured time.
12131213
Benchmark* MinRelAccuracy(double r);
12141214

src/benchmark.cc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,9 @@ BM_DEFINE_string(benchmark_min_time, kDefaultMinTimeStr);
8989
// Manual timers provide per-iteration times. The relative accuracy is
9090
// measured as the standard deviation of these per-iteration times divided by
9191
// the mean and the square root of the number of iterations. The benchmark is
92-
// run until the specified minimum time or number of iterations is reached
93-
// and the measured relative accuracy meets the specified requirement.
92+
// run until both of the following conditions are fulfilled:
93+
// 1. the specified minimum time or number of iterations is reached
94+
// 2. the measured relative accuracy meets the specified requirement
9495
BM_DEFINE_double(benchmark_min_rel_accuracy, 0.0);
9596

9697
// Minimum number of seconds a benchmark should be run before results should be

0 commit comments

Comments
 (0)