Skip to content

Commit d0be932

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

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
@@ -744,10 +744,10 @@ is emitted immediately after queuing the last chunk of payload data to be sent.
744744
The `http2stream.sendTrailers()` method can then be called to send trailing
745745
headers to the peer.
746746

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

752752
The `:method` and `:path` pseudo-headers are not specified within `headers`,
753753
they respectively default to:
@@ -1290,10 +1290,10 @@ will be emitted immediately after queuing the last chunk of payload data to be
12901290
sent. The `http2stream.sendTrailers()` method can then be used to sent trailing
12911291
header fields to the peer.
12921292

1293-
It is important to note that when `options.waitForTrailers` is set, the
1294-
`Http2Stream` will *not* automatically close when the final `DATA` frame is
1295-
transmitted. User code *must* call either `http2stream.sendTrailers()` or
1296-
`http2stream.close()` to close the `Http2Stream`.
1293+
When `options.waitForTrailers` is set, the `Http2Stream` will not automatically
1294+
close when the final `DATA` frame is transmitted. User code must call either
1295+
`http2stream.sendTrailers()` or `http2stream.close()` to close the
1296+
`Http2Stream`.
12971297

12981298
```js
12991299
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');
@@ -1488,10 +1488,10 @@ will be emitted immediately after queuing the last chunk of payload data to be
14881488
sent. The `http2stream.sendTrilers()` method can then be used to sent trailing
14891489
header fields to the peer.
14901490

1491-
It is important to note that when `options.waitForTrailers` is set, the
1492-
`Http2Stream` will *not* automatically close when the final `DATA` frame is
1493-
transmitted. User code *must* call either `http2stream.sendTrailers()` or
1494-
`http2stream.close()` to close the `Http2Stream`.
1491+
When `options.waitForTrailers` is set, the `Http2Stream` will not automatically
1492+
close when the final `DATA` frame is transmitted. User code must call either
1493+
`http2stream.sendTrailers()` or `http2stream.close()` to close the
1494+
`Http2Stream`.
14951495

14961496
```js
14971497
const http2 = require('http2');

0 commit comments

Comments
 (0)