Commit 397235e
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 <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>1 parent 81364a7 commit 397235e
1 file changed
Lines changed: 16 additions & 16 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -746,10 +746,10 @@ is emitted immediately after queuing the last chunk of payload data to be sent. | |||
| 746 | 746 | The `http2stream.sendTrailers()` method can then be called to send trailing | |
| 747 | 747 | headers to the peer. | |
| 748 | 748 | ||
| 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`. | ||
| 753 | 753 | ||
| 754 | 754 | The `:method` and `:path` pseudo-headers are not specified within `headers`, | |
| 755 | 755 | they respectively default to: | |
@@ -1285,10 +1285,10 @@ will be emitted immediately after queuing the last chunk of payload data to be | |||
| 1285 | 1285 | sent. The `http2stream.sendTrailers()` method can then be used to sent trailing | |
| 1286 | 1286 | header fields to the peer. | |
| 1287 | 1287 | ||
| 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`. | ||
| 1292 | 1292 | ||
| 1293 | 1293 | ```js | |
| 1294 | 1294 | const http2 = require('http2'); | |
@@ -1369,10 +1369,10 @@ will be emitted immediately after queuing the last chunk of payload data to be | |||
| 1369 | 1369 | sent. The `http2stream.sendTrailers()` method can then be used to sent trailing | |
| 1370 | 1370 | header fields to the peer. | |
| 1371 | 1371 | ||
| 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`. | ||
| 1376 | 1376 | ||
| 1377 | 1377 | ```js | |
| 1378 | 1378 | const http2 = require('http2'); | |
@@ -1493,10 +1493,10 @@ will be emitted immediately after queuing the last chunk of payload data to be | |||
| 1493 | 1493 | sent. The `http2stream.sendTrilers()` method can then be used to sent trailing | |
| 1494 | 1494 | header fields to the peer. | |
| 1495 | 1495 | ||
| 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`. | ||
| 1500 | 1500 | ||
| 1501 | 1501 | ```js | |
| 1502 | 1502 | const http2 = require('http2'); | |
0 commit comments