Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: update events docs for consistency #33678

Merged
merged 2 commits into from
Jun 2, 2020
Merged

doc: update events docs for consistency #33678

merged 2 commits into from
Jun 2, 2020

Conversation

cjihrig
Copy link
Contributor

@cjihrig cjihrig commented May 31, 2020

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), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. events Issues and PRs related to the events subsystem / EventEmitter. labels May 31, 2020
@addaleax addaleax added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jun 1, 2020
@cjihrig
doc: remove "it is important"
d534052 
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 <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Juan José Arboleda <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
@cjihrig
doc: use consistent Default: in events
16eaacf 
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 <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Juan José Arboleda <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
@cjihrig cjihrig merged commit 16eaacf into nodejs:master Jun 2, 2020
@cjihrig
Copy link
Contributor Author

cjihrig commented Jun 2, 2020

Landed in f46ca0f...16eaacf. Thanks for the reviews!

@cjihrig cjihrig deleted the doc branch June 2, 2020 21:17
codebytere pushed a commit that referenced this pull request Jun 18, 2020
@cjihrig @codebytere
doc: remove "it is important"
1e4edd8 
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 <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Juan José Arboleda <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
codebytere pushed a commit that referenced this pull request Jun 18, 2020
@cjihrig @codebytere
doc: use consistent Default: in events
61bb789 
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 <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Juan José Arboleda <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
@codebytere codebytere mentioned this pull request Jun 28, 2020
Merged
codebytere pushed a commit that referenced this pull request Jun 30, 2020
@cjihrig @codebytere
doc: remove "it is important"
f54fb3c 
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 <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Juan José Arboleda <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
codebytere pushed a commit that referenced this pull request Jun 30, 2020
@cjihrig @codebytere
doc: use consistent Default: in events
9a2631a 
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 <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Juan José Arboleda <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
@addaleax addaleax mentioned this pull request Sep 25, 2020
Closed
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jasnell jasnell jasnell approved these changes

@addaleax addaleax addaleax approved these changes

@lpinca lpinca lpinca approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

@juanarbol juanarbol juanarbol approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. events Issues and PRs related to the events subsystem / EventEmitter.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@cjihrig @jasnell @addaleax @lpinca @BridgeAR @juanarbol @nodejs-github-bot