Skip to content

Commit 397235e

Browse files
Trotttargos
authored andcommitted
doc: simplify http2 wording and formatting
Remove `It is important to note that` and italics from `waitForTrailers` sentences. PR-URL: #22541 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent 81364a7 commit 397235e

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

doc/api/http2.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -746,10 +746,10 @@ is emitted immediately after queuing the last chunk of payload data to be sent.
746746
The `http2stream.sendTrailers()` method can then be called to send trailing
747747
headers to the peer.
748748

749-
It is important to note that when `options.waitForTrailers` is set, the
750-
`Http2Stream` will *not* automatically close when the final `DATA` frame is
751-
transmitted. User code *must* call either `http2stream.sendTrailers()` or
752-
`http2stream.close()` to close the `Http2Stream`.
749+
When `options.waitForTrailers` is set, the `Http2Stream` will not automatically
750+
close when the final `DATA` frame is transmitted. User code must call either
751+
`http2stream.sendTrailers()` or `http2stream.close()` to close the
752+
`Http2Stream`.
753753

754754
The `:method` and `:path` pseudo-headers are not specified within `headers`,
755755
they respectively default to:
@@ -1285,10 +1285,10 @@ will be emitted immediately after queuing the last chunk of payload data to be
12851285
sent. The `http2stream.sendTrailers()` method can then be used to sent trailing
12861286
header fields to the peer.
12871287

1288-
It is important to note that when `options.waitForTrailers` is set, the
1289-
`Http2Stream` will *not* automatically close when the final `DATA` frame is
1290-
transmitted. User code *must* call either `http2stream.sendTrailers()` or
1291-
`http2stream.close()` to close the `Http2Stream`.
1288+
When `options.waitForTrailers` is set, the `Http2Stream` will not automatically
1289+
close when the final `DATA` frame is transmitted. User code must call either
1290+
`http2stream.sendTrailers()` or `http2stream.close()` to close the
1291+
`Http2Stream`.
12921292

12931293
```js
12941294
const http2 = require('http2');
@@ -1369,10 +1369,10 @@ will be emitted immediately after queuing the last chunk of payload data to be
13691369
sent. The `http2stream.sendTrailers()` method can then be used to sent trailing
13701370
header fields to the peer.
13711371

1372-
It is important to note that when `options.waitForTrailers` is set, the
1373-
`Http2Stream` will *not* automatically close when the final `DATA` frame is
1374-
transmitted. User code *must* call either `http2stream.sendTrailers()` or
1375-
`http2stream.close()` to close the `Http2Stream`.
1372+
When `options.waitForTrailers` is set, the `Http2Stream` will not automatically
1373+
close when the final `DATA` frame is transmitted. User code *must* call either
1374+
`http2stream.sendTrailers()` or `http2stream.close()` to close the
1375+
`Http2Stream`.
13761376

13771377
```js
13781378
const http2 = require('http2');
@@ -1493,10 +1493,10 @@ will be emitted immediately after queuing the last chunk of payload data to be
14931493
sent. The `http2stream.sendTrilers()` method can then be used to sent trailing
14941494
header fields to the peer.
14951495

1496-
It is important to note that when `options.waitForTrailers` is set, the
1497-
`Http2Stream` will *not* automatically close when the final `DATA` frame is
1498-
transmitted. User code *must* call either `http2stream.sendTrailers()` or
1499-
`http2stream.close()` to close the `Http2Stream`.
1496+
When `options.waitForTrailers` is set, the `Http2Stream` will not automatically
1497+
close when the final `DATA` frame is transmitted. User code must call either
1498+
`http2stream.sendTrailers()` or `http2stream.close()` to close the
1499+
`Http2Stream`.
15001500

15011501
```js
15021502
const http2 = require('http2');

0 commit comments

Comments
 (0)