Skip to content

Commit f0a857f

Browse files
Trotttargos
authored andcommitted
doc: remove "note that" from http2.md
Refs: nodejs/remark-preset-lint-node#16 PR-URL: #28329 Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
1 parent f4c6f7a commit f0a857f

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

doc/api/http2.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -988,7 +988,7 @@ The `'trailers'` event is emitted when a block of headers associated with
988988
trailing header fields is received. The listener callback is passed the
989989
[HTTP/2 Headers Object][] and flags associated with the headers.
990990

991-
Note that this event might not be emitted if `http2stream.end()` is called
991+
This event might not be emitted if `http2stream.end()` is called
992992
before trailers are received and the incoming data is not being read or
993993
listened for.
994994

@@ -1488,7 +1488,7 @@ requests.
14881488

14891489
The file descriptor is not closed when the stream is closed, so it will need
14901490
to be closed manually once it is no longer needed.
1491-
Note that using the same file descriptor concurrently for multiple streams
1491+
Using the same file descriptor concurrently for multiple streams
14921492
is not supported and may result in data loss. Re-using a file descriptor
14931493
after a stream has finished is supported.
14941494

@@ -1669,7 +1669,7 @@ client should continue to send the request body, or generating an appropriate
16691669
HTTP response (e.g. 400 Bad Request) if the client should not continue to send
16701670
the request body.
16711671

1672-
Note that when this event is emitted and handled, the [`'request'`][] event will
1672+
When this event is emitted and handled, the [`'request'`][] event will
16731673
not be emitted.
16741674

16751675
#### Event: 'request'
@@ -1680,7 +1680,7 @@ added: v8.4.0
16801680
* `request` {http2.Http2ServerRequest}
16811681
* `response` {http2.Http2ServerResponse}
16821682

1683-
Emitted each time there is a request. Note that there may be multiple requests
1683+
Emitted each time there is a request. There may be multiple requests
16841684
per session. See the [Compatibility API][].
16851685

16861686
#### Event: 'session'
@@ -1750,7 +1750,7 @@ added: v8.4.0
17501750

17511751
Stops the server from accepting new connections. See [`net.Server.close()`][].
17521752

1753-
Note that this is not analogous to restricting new requests since HTTP/2
1753+
This is not analogous to restricting new requests since HTTP/2
17541754
connections are persistent. To achieve a similar graceful shutdown behavior,
17551755
consider also using [`http2session.close()`] on active sessions.
17561756

@@ -1805,7 +1805,7 @@ client should continue to send the request body, or generating an appropriate
18051805
HTTP response (e.g. 400 Bad Request) if the client should not continue to send
18061806
the request body.
18071807

1808-
Note that when this event is emitted and handled, the [`'request'`][] event will
1808+
When this event is emitted and handled, the [`'request'`][] event will
18091809
not be emitted.
18101810

18111811
#### Event: 'request'
@@ -1816,7 +1816,7 @@ added: v8.4.0
18161816
* `request` {http2.Http2ServerRequest}
18171817
* `response` {http2.Http2ServerResponse}
18181818

1819-
Emitted each time there is a request. Note that there may be multiple requests
1819+
Emitted each time there is a request. There may be multiple requests
18201820
per session. See the [Compatibility API][].
18211821

18221822
#### Event: 'session'
@@ -1895,7 +1895,7 @@ added: v8.4.0
18951895

18961896
Stops the server from accepting new connections. See [`tls.Server.close()`][].
18971897

1898-
Note that this is not analogous to restricting new requests since HTTP/2
1898+
This is not analogous to restricting new requests since HTTP/2
18991899
connections are persistent. To achieve a similar graceful shutdown behavior,
19001900
consider also using [`http2session.close()`] on active sessions.
19011901

@@ -2771,7 +2771,7 @@ added: v8.4.0
27712771

27722772
The raw request/response headers list exactly as they were received.
27732773

2774-
Note that the keys and values are in the same list. It is *not* a
2774+
The keys and values are in the same list. It is *not* a
27752775
list of tuples. So, the even-numbered offsets are key values, and the
27762776
odd-numbered offsets are the associated values.
27772777

@@ -3035,7 +3035,7 @@ added: v8.4.0
30353035
* Returns: {string}
30363036

30373037
Reads out a header that has already been queued but not sent to the client.
3038-
Note that the name is case insensitive.
3038+
The name is case-insensitive.
30393039

30403040
```js
30413041
const contentType = response.getHeader('content-type');
@@ -3094,7 +3094,7 @@ added: v8.4.0
30943094
* Returns: {boolean}
30953095

30963096
Returns `true` if the header identified by `name` is currently set in the
3097-
outgoing headers. Note that the header name matching is case-insensitive.
3097+
outgoing headers. The header name matching is case-insensitive.
30983098

30993099
```js
31003100
const hasContentType = response.hasHeader('content-type');
@@ -3278,7 +3278,7 @@ it will switch to implicit header mode and flush the implicit headers.
32783278
This sends a chunk of the response body. This method may
32793279
be called multiple times to provide successive parts of the body.
32803280

3281-
Note that in the `http` module, the response body is omitted when the
3281+
In the `http` module, the response body is omitted when the
32823282
request is a HEAD request. Similarly, the `204` and `304` responses
32833283
_must not_ include a message body.
32843284

@@ -3341,12 +3341,12 @@ response.writeHead(200, {
33413341
'Content-Type': 'text/plain' });
33423342
```
33433343

3344-
Note that Content-Length is given in bytes not characters. The
3344+
`Content-Length` is given in bytes not characters. The
33453345
`Buffer.byteLength()` API may be used to determine the number of bytes in a
33463346
given encoding. On outbound messages, Node.js does not check if Content-Length
33473347
and the length of the body being transmitted are equal or not. However, when
33483348
receiving messages, Node.js will automatically reject messages when the
3349-
Content-Length does not match the actual payload size.
3349+
`Content-Length` does not match the actual payload size.
33503350

33513351
This method may be called at most one time on a message before
33523352
[`response.end()`][] is called.

0 commit comments

Comments
 (0)