1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

http2: fix documentation nits

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/14239
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
This commit is contained in:
James M Snell 2017-07-17 10:43:33 -07:00
parent 6dea193aca
commit f070d784d6
3 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/api/errors.md
View File

@ -793,7 +793,7 @@ been closed.
<a id="ERR_HTTP2_STREAM_ERROR"></a> <a id="ERR_HTTP2_STREAM_ERROR"></a>
### ERR_HTTP2_STREAM_ERROR ### ERR_HTTP2_STREAM_ERROR
Used when a non-zero error code has been specified in an RST_STREAM frame. Used when a non-zero error code has been specified in an `RST_STREAM` frame.
<a id="ERR_HTTP2_STREAM_SELF_DEPENDENCY"></a> <a id="ERR_HTTP2_STREAM_SELF_DEPENDENCY"></a>
### ERR_HTTP2_STREAM_SELF_DEPENDENCY ### ERR_HTTP2_STREAM_SELF_DEPENDENCY

12
doc/api/http2.md
View File

@ -559,7 +559,7 @@ when:
* A new HTTP/2 `HEADERS` frame with a previously unused stream ID is received; * A new HTTP/2 `HEADERS` frame with a previously unused stream ID is received;
* The `http2stream.pushStream()` method is called. * The `http2stream.pushStream()` method is called.
On the client side, instances of [`ClientHttp2Stream`[] are created when the On the client side, instances of [`ClientHttp2Stream`][] are created when the
`http2session.request()` method is called. `http2session.request()` method is called.
*Note*: On the client, the `Http2Stream` instance returned by *Note*: On the client, the `Http2Stream` instance returned by
@ -1451,7 +1451,7 @@ added: REPLACEME
* `settings` {[Settings Object][]} * `settings` {[Settings Object][]}
* Returns: {Buffer} * Returns: {Buffer}
Returns a [Buffer][] instance containing serialized representation of the given Returns a `Buffer` instance containing serialized representation of the given
HTTP/2 settings as specified in the [HTTP/2][] specification. This is intended HTTP/2 settings as specified in the [HTTP/2][] specification. This is intended
for use with the `HTTP2-Settings` header field. for use with the `HTTP2-Settings` header field.
@ -1691,13 +1691,13 @@ TBD
[`net.Socket`]: net.html [`net.Socket`]: net.html
[`tls.TLSSocket`]: tls.html [`tls.TLSSocket`]: tls.html
[`tls.createServer()`]: tls.html#tls_tls_createserver_options_secureconnectionlistener [`tls.createServer()`]: tls.html#tls_tls_createserver_options_secureconnectionlistener
[ClientHttp2Stream]: #http2_class_clienthttp2stream [`ClientHttp2Stream`]: #http2_class_clienthttp2stream
[Compatibility API: #http2_compatibility_api [Compatibility API]: #http2_compatibility_api
[`Duplex`]: stream.html#stream_class_stream_duplex [`Duplex`]: stream.html#stream_class_stream_duplex
[Headers Object]: #http2_headers_object [Headers Object]: #http2_headers_object
[Http2Stream]: #http2_class_http2stream [`Http2Stream`]: #http2_class_http2stream
[Http2Session and Sockets]: #http2_http2sesion_and_sockets [Http2Session and Sockets]: #http2_http2sesion_and_sockets
[ServerHttp2Stream]: #http2_class_serverhttp2stream [`ServerHttp2Stream`]: #http2_class_serverhttp2stream
[Settings Object]: #http2_settings_object [Settings Object]: #http2_settings_object
[Using options.selectPadding]: #http2_using_options_selectpadding [Using options.selectPadding]: #http2_using_options_selectpadding
[error code]: #error_codes [error code]: #error_codes

2
doc/guides/writing-and-running-benchmarks.md
View File

@ -45,7 +45,7 @@ benchmarker to be used should be specified by providing it as an argument:
To run the `http2` benchmarks, the `h2load` benchmarker must be used. The To run the `http2` benchmarks, the `h2load` benchmarker must be used. The
`h2load` tool is a component of the `nghttp2` project and may be installed `h2load` tool is a component of the `nghttp2` project and may be installed
from [nghttp.org][] or built from source. from [nghttp2.org][] or built from source.
`node benchmark/http2/simple.js benchmarker=autocannon` `node benchmark/http2/simple.js benchmarker=autocannon`