Skip to content

Commit a081b43

Browse files
TrottTrott
committed
doc: simplify http2 wording and formatting
Remove `It is important to note that` and italics from `waitForTrailers` sentences. PR-URL: nodejs#22541 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
1 parent d8855e4 commit a081b43

1 file changed

Lines changed: 16 additions & 16 deletions

File tree

‎doc/api/http2.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -752,10 +752,10 @@ is emitted immediately after queuing the last chunk of payload data to be sent.
752752
The `http2stream.sendTrailers()` method can then be called to send trailing
753753
headers to the peer.
754754

755-
It is important to note that when `options.waitForTrailers` is set, the
756-
`Http2Stream` will *not* automatically close when the final `DATA` frame is
757-
transmitted. User code *must* call either `http2stream.sendTrailers()` or
758-
`http2stream.close()` to close the `Http2Stream`.
755+
When `options.waitForTrailers` is set, the `Http2Stream` will not automatically
756+
close when the final `DATA` frame is transmitted. User code must call either
757+
`http2stream.sendTrailers()` or `http2stream.close()` to close the
758+
`Http2Stream`.
759759

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

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

12991299
```js
13001300
const http2 = require('http2');
@@ -1375,10 +1375,10 @@ will be emitted immediately after queuing the last chunk of payload data to be
13751375
sent. The `http2stream.sendTrailers()` method can then be used to sent trailing
13761376
header fields to the peer.
13771377

1378-
It is important to note that when `options.waitForTrailers` is set, the
1379-
`Http2Stream` will *not* automatically close when the final `DATA` frame is
1380-
transmitted. User code *must* call either `http2stream.sendTrailers()` or
1381-
`http2stream.close()` to close the `Http2Stream`.
1378+
When `options.waitForTrailers` is set, the `Http2Stream` will not automatically
1379+
close when the final `DATA` frame is transmitted. User code *must* call either
1380+
`http2stream.sendTrailers()` or `http2stream.close()` to close the
1381+
`Http2Stream`.
13821382

13831383
```js
13841384
const http2 = require('http2');
@@ -1499,10 +1499,10 @@ will be emitted immediately after queuing the last chunk of payload data to be
14991499
sent. The `http2stream.sendTrilers()` method can then be used to sent trailing
15001500
header fields to the peer.
15011501

1502-
It is important to note that when `options.waitForTrailers` is set, the
1503-
`Http2Stream` will *not* automatically close when the final `DATA` frame is
1504-
transmitted. User code *must* call either `http2stream.sendTrailers()` or
1505-
`http2stream.close()` to close the `Http2Stream`.
1502+
When `options.waitForTrailers` is set, the `Http2Stream` will not automatically
1503+
close when the final `DATA` frame is transmitted. User code must call either
1504+
`http2stream.sendTrailers()` or `http2stream.close()` to close the
1505+
`Http2Stream`.
15061506

15071507
```js
15081508
const http2 = require('http2');

0 commit comments

Comments
 (0)