diff options
| author | Rich Trott <rtrott@gmail.com> | 2020-08-03 19:17:54 +0300 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2020-08-05 02:27:20 +0300 |
| commit | 319c275b26db7ccfaac4ef67f9dedefc2379d0dd (patch) | |
| tree | 682869d242541410ffcf166ffd0d889f4454fb93 /doc/api/quic.md | |
| parent | 3ea94ec84510f5ecd08b75e6e10ef7c5f5df4fe8 (diff) | |
doc: use _can_ to describe actions in quic.md
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 <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Diffstat (limited to 'doc/api/quic.md')
| -rw-r--r-- | doc/api/quic.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/api/quic.md b/doc/api/quic.md index 897f39245c2..c0df4758d8b 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. |