Skip to content

Commit 392c86d

Browse files
Trottdanielleadams
authored andcommitted
doc: use sentence case in benchmark doc
Apply sentence case consistently in headers in benchmark doc. PR-URL: #37351 Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 62b2648 commit 392c86d

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

doc/guides/writing-and-running-benchmarks.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
# How to Write and Run Benchmarks in Node.js Core
1+
# How to write and run benchmarks in Node.js core
22

3-
## Table of Contents
3+
## Table of contents
44

55
* [Prerequisites](#prerequisites)
6-
* [HTTP Benchmark Requirements](#http-benchmark-requirements)
7-
* [HTTPS Benchmark Requirements](#https-benchmark-requirements)
8-
* [HTTP/2 Benchmark Requirements](#http2-benchmark-requirements)
9-
* [Benchmark Analysis Requirements](#benchmark-analysis-requirements)
6+
* [HTTP benchmark requirements](#http-benchmark-requirements)
7+
* [HTTPS benchmark requirements](#https-benchmark-requirements)
8+
* [HTTP/2 benchmark requirements](#http2-benchmark-requirements)
9+
* [Benchmark analysis requirements](#benchmark-analysis-requirements)
1010
* [Running benchmarks](#running-benchmarks)
1111
* [Running individual benchmarks](#running-individual-benchmarks)
1212
* [Running all benchmarks](#running-all-benchmarks)
1313
* [Filtering benchmarks](#filtering-benchmarks)
1414
* [Comparing Node.js versions](#comparing-nodejs-versions)
1515
* [Comparing parameters](#comparing-parameters)
16-
* [Running Benchmarks on the CI](#running-benchmarks-on-the-ci)
16+
* [Running benchmarks on the CI](#running-benchmarks-on-the-ci)
1717
* [Creating a benchmark](#creating-a-benchmark)
1818
* [Basics of a benchmark](#basics-of-a-benchmark)
1919
* [Creating an HTTP benchmark](#creating-an-http-benchmark)
@@ -24,7 +24,7 @@ Basic Unix tools are required for some benchmarks.
2424
[Git for Windows][git-for-windows] includes Git Bash and the necessary tools,
2525
which need to be included in the global Windows `PATH`.
2626

27-
### HTTP Benchmark Requirements
27+
### HTTP benchmark requirements
2828

2929
Most of the HTTP benchmarks require a benchmarker to be installed. This can be
3030
either [`wrk`][wrk] or [`autocannon`][autocannon].
@@ -45,22 +45,22 @@ benchmarker to be used should be specified by providing it as an argument:
4545

4646
`node benchmark/http/simple.js benchmarker=autocannon`
4747

48-
#### HTTPS Benchmark Requirements
48+
#### HTTPS benchmark requirements
4949

5050
To run the `https` benchmarks, one of `autocannon` or `wrk` benchmarkers must
5151
be used.
5252

5353
`node benchmark/https/simple.js benchmarker=autocannon`
5454

55-
#### HTTP/2 Benchmark Requirements
55+
#### HTTP/2 benchmark requirements
5656

5757
To run the `http2` benchmarks, the `h2load` benchmarker must be used. The
5858
`h2load` tool is a component of the `nghttp2` project and may be installed
5959
from [nghttp2.org][] or built from source.
6060

6161
`node benchmark/http2/simple.js benchmarker=h2load`
6262

63-
### Benchmark Analysis Requirements
63+
### Benchmark analysis requirements
6464

6565
To analyze the results, `R` should be installed. Use one of the available
6666
package managers or download it from <https://www.r-project.org/>.
@@ -423,7 +423,7 @@ chunkLen encoding rate confidence.interval
423423

424424
![compare tool boxplot](doc_img/scatter-plot.png)
425425

426-
### Running Benchmarks on the CI
426+
### Running benchmarks on the CI
427427

428428
To see the performance impact of a Pull Request by running benchmarks on
429429
the CI, check out [How to: Running core benchmarks on Node.js CI][benchmark-ci].

0 commit comments

Comments
 (0)