From 2c3092088679b355804416eb8afcf6a667a0df40 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 20 Jul 2020 16:18:37 -0700 Subject: [PATCH] doc: use sentence-case in quic.md headers For consistency with the rest of our docs and our style guide, use sentence-case rather than headline-case in the headers in quic.md. PR-URL: https://github.com/nodejs/node/pull/34453 Reviewed-By: James M Snell Reviewed-By: Trivikram Kamat Reviewed-By: Luigi Pinca --- doc/api/quic.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/api/quic.md b/doc/api/quic.md index b116d7f9900b5d..af30e251f8280b 100644 --- a/doc/api/quic.md +++ b/doc/api/quic.md @@ -58,7 +58,7 @@ socket.on('session', (session) => { ``` -## QUIC Basics +## QUIC basics QUIC is a UDP-based network transport protocol that includes built-in security via TLS 1.3, flow control, error correction, connection migration, @@ -84,7 +84,7 @@ Unlike the `net.Socket` and `tls.TLSSocket`, a `QuicSocket` instance cannot be directly used by user code at the JavaScript level to send or receive data over the network. -### Client and Server QuicSessions +### Client and server QuicSessions A `QuicSession` represents a logical connection between two QUIC endpoints (a client and a server). In the JavaScript API, each is represented by the @@ -212,7 +212,7 @@ session.on('stream', (stream) => { }); ``` -#### QuicStream Headers +#### QuicStream headers Some QUIC application protocols (like HTTP/3) make use of headers. @@ -498,7 +498,7 @@ also use explicit scope in addresses, so only packets sent to a multicast address without specifying an explicit scope are affected by the most recent successful use of this call. -##### Examples: IPv6 Outgoing Multicast Interface +##### Examples: IPv6 outgoing multicast interface @@ -524,7 +524,7 @@ socket.on('ready', () => { }); ``` -##### Example: IPv4 Outgoing Multicast Interface +##### Example: IPv4 outgoing multicast interface @@ -539,7 +539,7 @@ socket.on('ready', () => { }); ``` -##### Call Results +##### Call results A call on a socket that is not ready to send or no longer open may throw a Not running Error. @@ -2417,9 +2417,9 @@ added: REPLACEME Set to `true` if the `QuicStream` is unidirectional. -## Additional Notes +## Additional notes -### Custom DNS Lookup Functions +### Custom DNS lookup functions By default, the QUIC implementation uses the `dns` module's [promisified version of `lookup()`][] to resolve domains names