Skip to content

Commit

Permalink
doc: use _can_ to describe actions in quic.md
Browse files Browse the repository at this point in the history
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: #34353 (comment)

PR-URL: #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>
  • Loading branch information
Trott committed Aug 4, 2020
1 parent 3ea94ec commit 319c275
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/api/quic.md
Expand Up @@ -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.
Expand Down

0 comments on commit 319c275

Please sign in to comment.