Skip to content

Commit 8541b3b

Browse files
committed
Marked keywords.
1 parent 2cec067 commit 8541b3b

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,17 @@ Write inline benchmarks using the functions:
3636

3737
The functions [`benchmark`][benchmark] and [`asyncBenchmark`][asyncBenchmark]
3838
accept the following optional parameters:
39-
* setup: A function that is executed *before* the benchmark runs.
40-
* teardown: A function that is executed *after* the benchmark runs,
41-
* scoreEmitter: An object responsible for formatting the score results
42-
(defaults value: `StatsEmitter`).
43-
* warmUpDuration: The time expended on warm up runs used to generate a
44-
preliminary score estimate (defaults to `Duration(milliseconds: 200)`).
45-
* sampleSize: Used to manually specify the score sample size and
39+
* `setup`: A function that is executed *before* the benchmark runs.
40+
* `teardown`: A function that is executed *after* the benchmark runs,
41+
* `scoreEmitter`: An object responsible for formatting the score results.
42+
Its default value is: `StatsEmitter()`.
43+
* `warmUpDuration`: The time expended on warm-up runs used to generate a
44+
preliminary score estimate. The default warm-up duration is:
45+
`Duration(milliseconds: 200)`.
46+
* `sampleSize`: Used to manually specify the score sample size and
4647
over how many runs each score entry should be averaged.
4748
If this parameter is omitted,
48-
it will be calculated using [`sampleSize`][sampleSize].
49+
it will be calculated using the function [`sampleSize`][sampleSize].
4950

5051
The example below shows a benchmark file containing synchronous benchmarks
5152
and two benchmark groups:

0 commit comments

Comments
 (0)