From 319c275b26db7ccfaac4ef67f9dedefc2379d0dd Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 3 Aug 2020 09:17:54 -0700 Subject: [PATCH] doc: use _can_ to describe actions in quic.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Per Microsoft style guide: > When ability is what you need to express, it's OK to use _can_ to > describe actions or tasks that the reader or program is able to do. > Use _might_ to express possibility. Don't use _may_, which might be > interpreted as providing permission. Refs: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/can-may Refs: https://github.com/nodejs/node/pull/34353#issuecomment-659169228 PR-URL: https://github.com/nodejs/node/pull/34613 Reviewed-By: Luigi Pinca Reviewed-By: James M Snell Reviewed-By: Gerhard Stöbich --- doc/api/quic.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/quic.md b/doc/api/quic.md index 897f39245c2200..c0df4758d8bb6c 100644 --- a/doc/api/quic.md +++ b/doc/api/quic.md @@ -2465,7 +2465,7 @@ start of a new `QuicServerSession`. It is invoked with three arguments: * `servername` {string} The SNI server name specified by the client. * `ciphers` {string[]} The array of TLS 1.3 ciphers specified by the client. -The `clientHelloHandler` *may* return a new {tls.SecureContext} object that will +The `clientHelloHandler` can return a new {tls.SecureContext} object that will be used to continue the TLS handshake. If the function returns `undefined`, the default {tls.SecureContext} will be used. Returning any other value will cause an error to be thrown that will destroy the `QuicServerSession` instance.