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 <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Gerhard Stöbich <[email protected]>
  • Loading branch information
Trott committed Aug 4, 2020
1 parent 319c275 commit d5c7aec
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/api/quic.md
Original file line number Diff line number Diff line change
Expand Up @@ -1388,7 +1388,7 @@ server.listen();

The `'session'` event will be emitted multiple times.

The `'session'` event handler *may* be an async function.
The `'session'` event handler can be an async function.

If the `'session'` event handler throws an error, or if it returns a `Promise`
that is rejected, the error will be handled by destroying the `QuicServerSession`
Expand Down

0 comments on commit d5c7aec

Please sign in to comment.