doc: update events docs for consistency #33678
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
doc
jasnell
approved these changes
Jun 1, 2020
addaleax
approved these changes
Jun 1, 2020
addaleax
added
the
author ready
lpinca
approved these changes
Jun 1, 2020
juanarbol
approved these changes
Jun 1, 2020
BridgeAR
approved these changes
Jun 2, 2020
In the spirit of nodejs#30108, remove the use of "it is important" in the new EventTarget docs. PR-URL: nodejs#33678 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
The API docs have been migrating to **Default:** when providing default values. This commit updates the events documentation page for consistency. PR-URL: nodejs#33678 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
|
Landed in f46ca0f...16eaacf. Thanks for the reviews! |
codebytere
pushed a commit
that referenced
this pull request
Jun 18, 2020
In the spirit of #30108, remove the use of "it is important" in the new EventTarget docs. PR-URL: #33678 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
codebytere
pushed a commit
that referenced
this pull request
Jun 18, 2020
The API docs have been migrating to **Default:** when providing default values. This commit updates the events documentation page for consistency. PR-URL: #33678 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Merged
codebytere
pushed a commit
that referenced
this pull request
Jun 30, 2020
In the spirit of #30108, remove the use of "it is important" in the new EventTarget docs. PR-URL: #33678 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
codebytere
pushed a commit
that referenced
this pull request
Jun 30, 2020
The API docs have been migrating to **Default:** when providing default values. This commit updates the events documentation page for consistency. PR-URL: #33678 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the events docs to remove language that is advised against in our doc style guide, and make default values consistent.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes