From e8cc193bcc2bc7796a7d3a8efede41fdad11c31f Mon Sep 17 00:00:00 2001 From: James M Snell Date: Mon, 17 Jul 2017 10:43:33 -0700 Subject: [PATCH] http2: fix documentation nits Backport-PR-URL: https://github.com/nodejs/node/pull/14813 Backport-Reviewed-By: Anna Henningsen Backport-Reviewed-By: Timothy Gu PR-URL: https://github.com/nodejs/node/pull/14239 Reviewed-By: Anna Henningsen Reviewed-By: Colin Ihrig Reviewed-By: Matteo Collina --- doc/api/errors.md | 2 +- doc/api/http2.md | 12 ++++++------ doc/guides/writing-and-running-benchmarks.md | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/api/errors.md b/doc/api/errors.md index 7e4d594bb13e34..93d6a25173cc17 100644 --- a/doc/api/errors.md +++ b/doc/api/errors.md @@ -773,7 +773,7 @@ been closed. ### 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. ### ERR_HTTP2_STREAM_SELF_DEPENDENCY diff --git a/doc/api/http2.md b/doc/api/http2.md index ca696de81e3aac..9beb2cac922986 100755 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -559,7 +559,7 @@ when: * A new HTTP/2 `HEADERS` frame with a previously unused stream ID is received; * 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. *Note*: On the client, the `Http2Stream` instance returned by @@ -1451,7 +1451,7 @@ added: REPLACEME * `settings` {[Settings Object][]} * 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 for use with the `HTTP2-Settings` header field. @@ -1691,13 +1691,13 @@ TBD [`net.Socket`]: net.html [`tls.TLSSocket`]: tls.html [`tls.createServer()`]: tls.html#tls_tls_createserver_options_secureconnectionlistener -[ClientHttp2Stream]: #http2_class_clienthttp2stream -[Compatibility API: #http2_compatibility_api +[`ClientHttp2Stream`]: #http2_class_clienthttp2stream +[Compatibility API]: #http2_compatibility_api [`Duplex`]: stream.html#stream_class_stream_duplex [Headers Object]: #http2_headers_object -[Http2Stream]: #http2_class_http2stream +[`Http2Stream`]: #http2_class_http2stream [Http2Session and Sockets]: #http2_http2sesion_and_sockets -[ServerHttp2Stream]: #http2_class_serverhttp2stream +[`ServerHttp2Stream`]: #http2_class_serverhttp2stream [Settings Object]: #http2_settings_object [Using options.selectPadding]: #http2_using_options_selectpadding [error code]: #error_codes diff --git a/doc/guides/writing-and-running-benchmarks.md b/doc/guides/writing-and-running-benchmarks.md index 7aeb9728aaedf0..d418ed6974bf80 100644 --- a/doc/guides/writing-and-running-benchmarks.md +++ b/doc/guides/writing-and-running-benchmarks.md @@ -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 `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`