diff options
| author | Rich Trott <rtrott@gmail.com> | 2018-08-26 15:45:53 -0700 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2018-08-26 23:10:33 -0700 |
| commit | a081b43919644adcae0491948cd994946f132be7 (patch) | |
| tree | 31737db72415e2e856e9752f3166df942ee5a556 /doc | |
| parent | d8855e44760fa401393c44dba1dbb5a91c2c0e11 (diff) | |
| download | android-node-v8-a081b43919644adcae0491948cd994946f132be7.tar.gz android-node-v8-a081b43919644adcae0491948cd994946f132be7.tar.bz2 android-node-v8-a081b43919644adcae0491948cd994946f132be7.zip | |
doc: simplify http2 wording and formatting
Remove `It is important to note that` and italics from `waitForTrailers`
sentences.
PR-URL: https://github.com/nodejs/node/pull/22541
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/http2.md | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/doc/api/http2.md b/doc/api/http2.md index bb8b1d4078..b08e3b3498 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -752,10 +752,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: @@ -1291,10 +1291,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'); @@ -1375,10 +1375,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'); @@ -1499,10 +1499,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'); |