Skip to content

Commit

Permalink
doc: simplify http2 wording and formatting
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
Trott authored and targos committed Sep 3, 2018
1 parent 81364a7 commit 397235e
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions doc/api/http2.md
Original file line number Diff line number Diff line change
Expand Up @@ -746,10 +746,10 @@ is emitted immediately after queuing the last chunk of payload data to be sent.
The `http2stream.sendTrailers()` method can then be called to send trailing
headers to the peer.

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

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

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

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

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

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

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

```js
const http2 = require('http2');
Expand Down

0 comments on commit 397235e

Please sign in to comment.