Skip to content

Commit e8cc193

Browse files
jasnelladdaleax
authored andcommitted
http2: fix documentation nits
Backport-PR-URL: #14813 Backport-Reviewed-By: Anna Henningsen <anna@addaleax.net> Backport-Reviewed-By: Timothy Gu <timothygu99@gmail.com> PR-URL: #14239 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
1 parent a49146e commit e8cc193

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

doc/api/errors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -773,7 +773,7 @@ been closed.
773773
<a id="ERR_HTTP2_STREAM_ERROR"></a>
774774
### ERR_HTTP2_STREAM_ERROR
775775

776-
Used when a non-zero error code has been specified in an RST_STREAM frame.
776+
Used when a non-zero error code has been specified in an `RST_STREAM` frame.
777777

778778
<a id="ERR_HTTP2_STREAM_SELF_DEPENDENCY"></a>
779779
### ERR_HTTP2_STREAM_SELF_DEPENDENCY

doc/api/http2.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -559,7 +559,7 @@ when:
559559
* A new HTTP/2 `HEADERS` frame with a previously unused stream ID is received;
560560
* The `http2stream.pushStream()` method is called.
561561

562-
On the client side, instances of [`ClientHttp2Stream`[] are created when the
562+
On the client side, instances of [`ClientHttp2Stream`][] are created when the
563563
`http2session.request()` method is called.
564564

565565
*Note*: On the client, the `Http2Stream` instance returned by
@@ -1451,7 +1451,7 @@ added: REPLACEME
14511451
* `settings` {[Settings Object][]}
14521452
* Returns: {Buffer}
14531453

1454-
Returns a [Buffer][] instance containing serialized representation of the given
1454+
Returns a `Buffer` instance containing serialized representation of the given
14551455
HTTP/2 settings as specified in the [HTTP/2][] specification. This is intended
14561456
for use with the `HTTP2-Settings` header field.
14571457

@@ -1691,13 +1691,13 @@ TBD
16911691
[`net.Socket`]: net.html
16921692
[`tls.TLSSocket`]: tls.html
16931693
[`tls.createServer()`]: tls.html#tls_tls_createserver_options_secureconnectionlistener
1694-
[ClientHttp2Stream]: #http2_class_clienthttp2stream
1695-
[Compatibility API: #http2_compatibility_api
1694+
[`ClientHttp2Stream`]: #http2_class_clienthttp2stream
1695+
[Compatibility API]: #http2_compatibility_api
16961696
[`Duplex`]: stream.html#stream_class_stream_duplex
16971697
[Headers Object]: #http2_headers_object
1698-
[Http2Stream]: #http2_class_http2stream
1698+
[`Http2Stream`]: #http2_class_http2stream
16991699
[Http2Session and Sockets]: #http2_http2sesion_and_sockets
1700-
[ServerHttp2Stream]: #http2_class_serverhttp2stream
1700+
[`ServerHttp2Stream`]: #http2_class_serverhttp2stream
17011701
[Settings Object]: #http2_settings_object
17021702
[Using options.selectPadding]: #http2_using_options_selectpadding
17031703
[error code]: #error_codes

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ benchmarker to be used should be specified by providing it as an argument:
4545

4646
To run the `http2` benchmarks, the `h2load` benchmarker must be used. The
4747
`h2load` tool is a component of the `nghttp2` project and may be installed
48-
from [nghttp.org][] or built from source.
48+
from [nghttp2.org][] or built from source.
4949

5050
`node benchmark/http2/simple.js benchmarker=autocannon`
5151

0 commit comments

Comments
 (0)