From d0be932375c925df89f2434f1b38d2ad65ae328a Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sun, 26 Aug 2018 15:45:53 -0700 Subject: [PATCH] doc: simplify http2 wording and formatting Remove `It is important to note that` and italics from `waitForTrailers` sentences. Backport-PR-URL: https://github.com/nodejs/node/pull/22850 PR-URL: https://github.com/nodejs/node/pull/22541 Reviewed-By: Vse Mozhet Byt Reviewed-By: Luigi Pinca --- doc/api/http2.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/doc/api/http2.md b/doc/api/http2.md index ea53e7c48d50b9..7a8abcf4b58498 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -744,10 +744,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: @@ -1290,10 +1290,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'); @@ -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'); @@ -1488,10 +1488,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');