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: fix setter of event.cancelBubble #45986

Merged
merged 4 commits into from
Jan 7, 2023
Merged

doc: fix setter of event.cancelBubble #45986

merged 4 commits into from
Jan 7, 2023

Conversation

deokjinkim
Copy link
Contributor

Setter of event.cancelBubble needs 1 argument(value). And event.cancelBubble() is working if value is true. But it's not described properly.

Refs: https://dom.spec.whatwg.org/#interface-event

@deokjinkim
doc: fix setter of event.cancelBubble
9dd8e84 
Setter of `event.cancelBubble` needs 1 argument(value).
And event.cancelBubble() is working if value is true.
But it's not described properly.

Refs: https://dom.spec.whatwg.org/#interface-event
@nodejs-github-bot nodejs-github-bot added the needs-ci PRs that need a full CI run. label Dec 27, 2022
aduh95
aduh95 reviewed Dec 28, 2022
View reviewed changes
Copy link
Contributor

@aduh95 aduh95 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cancelBubble is not a function, it's an attribute. Let's use this PR to fix that.

doc/api/events.md Outdated Show resolved Hide resolved
doc/api/events.md Outdated Show resolved Hide resolved
doc/api/events.md Outdated Show resolved Hide resolved
doc/api/events.md Outdated Show resolved Hide resolved
@deokjinkim @aduh95
Apply suggestions from code review
e320789 
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
@deokjinkim
Copy link
Contributor Author

cancelBubble is not a function, it's an attribute. Let's use this PR to fix that.

You're right. I'm confused for setter. Thank you for correction.

aduh95
aduh95 reviewed Dec 28, 2022
View reviewed changes
doc/api/events.md Outdated Show resolved Hide resolved
@deokjinkim @aduh95
Add missed Type: to specify data type
8f78b2e 
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
@deokjinkim @aduh95
Revert change of JSDoc
31f921e 
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
@aduh95 aduh95 added doc Issues and PRs related to the documentations. author ready PRs that have at least one approval, no pending requests for changes, and a CI started. eventtarget Issues and PRs related to the EventTarget implementation. and removed needs-ci PRs that need a full CI run. labels Dec 28, 2022
aymen94
aymen94 approved these changes Dec 29, 2022
View reviewed changes
lib/internal/event_target.js Outdated Show resolved Hide resolved
@deokjinkim
Copy link
Contributor Author

@aduh95 Could you please land this PR because this PR is created 1 week ago?

@addaleax addaleax added the commit-queue Add this label to land a pull request using GitHub Actions. label Jan 6, 2023
@nodejs-github-bot nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Jan 6, 2023
@nodejs-github-bot
Copy link
Collaborator

Commit Queue failed
- Loading data for nodejs/node/pull/45986
✔  Done loading data for nodejs/node/pull/45986
----------------------------------- PR info ------------------------------------
Title      doc: fix setter of `event.cancelBubble` (#45986)
Author     Deokjin Kim  (@deokjinkim)
Branch     deokjinkim:221227_revise_setter_cancelbubble -> nodejs:main
Labels     doc, author ready, eventtarget
Commits    4
 - doc: fix setter of `event.cancelBubble`
 - Apply suggestions from code review
 - Add missed `Type:` to specify data type
 - Revert change of JSDoc
Committers 2
 - Deokjin Kim 
 - GitHub 
PR-URL: https://github.com/nodejs/node/pull/45986
Refs: https://dom.spec.whatwg.org/#interface-event
Reviewed-By: Antoine du Hamel 
Reviewed-By: Anna Henningsen 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/45986
Refs: https://dom.spec.whatwg.org/#interface-event
Reviewed-By: Antoine du Hamel 
Reviewed-By: Anna Henningsen 
--------------------------------------------------------------------------------
   ℹ  This PR was created on Tue, 27 Dec 2022 09:40:07 GMT
   ✔  Approvals: 2
   ✔  - Antoine du Hamel (@aduh95) (TSC): https://github.com/nodejs/node/pull/45986#pullrequestreview-1232059481
   ✔  - Anna Henningsen (@addaleax): https://github.com/nodejs/node/pull/45986#pullrequestreview-1239531619
   ✔  Last GitHub CI successful
   ℹ  Green GitHub CI is sufficient
--------------------------------------------------------------------------------
   ✔  No git cherry-pick in progress
   ✔  No git am in progress
   ✔  No git rebase in progress
--------------------------------------------------------------------------------
- Bringing origin/main up to date...
From https://github.com/nodejs/node
 * branch                  main       -> FETCH_HEAD
✔  origin/main is now up-to-date
- Downloading patch for 45986
From https://github.com/nodejs/node
 * branch                  refs/pull/45986/merge -> FETCH_HEAD
✔  Fetched commits as 4788c0d2a02a..31f921ee0e1e
--------------------------------------------------------------------------------
Auto-merging doc/api/events.md
Auto-merging lib/internal/event_target.js
[main e1857dd49d] doc: fix setter of `event.cancelBubble`
 Author: Deokjin Kim 
 Date: Tue Dec 27 18:29:20 2022 +0900
 2 files changed, 6 insertions(+), 4 deletions(-)
Auto-merging doc/api/events.md
[main 5a015f9058] Apply suggestions from code review
 Author: Deokjin Kim 
 Date: Wed Dec 28 23:10:59 2022 +0900
 1 file changed, 3 insertions(+), 3 deletions(-)
Auto-merging doc/api/events.md
[main 85dd674059] Add missed `Type:` to specify data type
 Author: Deokjin Kim 
 Date: Thu Dec 29 07:42:22 2022 +0900
 1 file changed, 1 insertion(+), 1 deletion(-)
Auto-merging lib/internal/event_target.js
[main d5b4a2971d] Revert change of JSDoc
 Author: Deokjin Kim 
 Date: Thu Dec 29 07:50:01 2022 +0900
 1 file changed, 1 insertion(+), 1 deletion(-)
   ✔  Patches applied
There are 4 commits in the PR. Attempting autorebase.
Rebasing (2/8)

Executing: git node land --amend --yes

⚠  Found Refs: https://dom.spec.whatwg.org/#interface-event, skipping..

--------------------------------- New Message ----------------------------------

doc: fix setter of event.cancelBubble


Setter of event.cancelBubble needs 1 argument(value).

And event.cancelBubble() is working if value is true.

But it's not described properly.


Refs: https://dom.spec.whatwg.org/#interface-event

PR-URL: #45986

Reviewed-By: Antoine du Hamel duhamelantoine1995@gmail.com

Reviewed-By: Anna Henningsen anna@addaleax.net


[detached HEAD 37f393d875] doc: fix setter of event.cancelBubble

Author: Deokjin Kim deokjin81.kim@gmail.com

Date: Tue Dec 27 18:29:20 2022 +0900

2 files changed, 6 insertions(+), 4 deletions(-)

Rebasing (3/8)

Rebasing (4/8)


Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

Apply suggestions from code review


Co-authored-by: Antoine du Hamel duhamelantoine1995@gmail.com

PR-URL: #45986

Refs: https://dom.spec.whatwg.org/#interface-event

Reviewed-By: Antoine du Hamel duhamelantoine1995@gmail.com

Reviewed-By: Anna Henningsen anna@addaleax.net


[detached HEAD 1414069ff4] Apply suggestions from code review

Author: Deokjin Kim deokjin81.kim@gmail.com

Date: Wed Dec 28 23:10:59 2022 +0900

1 file changed, 3 insertions(+), 3 deletions(-)

Rebasing (5/8)

Rebasing (6/8)


Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

Add missed Type: to specify data type


Co-authored-by: Antoine du Hamel duhamelantoine1995@gmail.com

PR-URL: #45986

Refs: https://dom.spec.whatwg.org/#interface-event

Reviewed-By: Antoine du Hamel duhamelantoine1995@gmail.com

Reviewed-By: Anna Henningsen anna@addaleax.net


[detached HEAD 445eeedc30] Add missed Type: to specify data type

Author: Deokjin Kim deokjin81.kim@gmail.com

Date: Thu Dec 29 07:42:22 2022 +0900

1 file changed, 1 insertion(+), 1 deletion(-)

Rebasing (7/8)

Rebasing (8/8)


Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

Revert change of JSDoc


Co-authored-by: Antoine du Hamel duhamelantoine1995@gmail.com

PR-URL: #45986

Refs: https://dom.spec.whatwg.org/#interface-event

Reviewed-By: Antoine du Hamel duhamelantoine1995@gmail.com

Reviewed-By: Anna Henningsen anna@addaleax.net


[detached HEAD b838c68149] Revert change of JSDoc

Author: Deokjin Kim deokjin81.kim@gmail.com

Date: Thu Dec 29 07:50:01 2022 +0900

1 file changed, 1 insertion(+), 1 deletion(-)


Successfully rebased and updated refs/heads/main.


ℹ  Add commit-queue-squash label to land the PR as one commit, or commit-queue-rebase to land as separate commits.
https://github.com/nodejs/node/actions/runs/3859357483

@aduh95 aduh95 merged commit 57add38 into nodejs:main Jan 7, 2023
@aduh95
Copy link
Contributor

aduh95 commented Jan 7, 2023

Landed in 57add38

RafaelGSS pushed a commit to RafaelGSS/node that referenced this pull request Jan 17, 2023
@deokjinkim @RafaelGSS
doc: fix event.cancelBubble documentation
e91d592 
Setter of `event.cancelBubble` is a no-op if the value passed to it is
not `true`.

Refs: https://dom.spec.whatwg.org/#interface-event
PR-URL: nodejs#45986
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
RafaelGSS pushed a commit that referenced this pull request Jan 20, 2023
@deokjinkim @RafaelGSS
doc: fix event.cancelBubble documentation
76408bc 
Setter of `event.cancelBubble` is a no-op if the value passed to it is
not `true`.

Refs: https://dom.spec.whatwg.org/#interface-event
PR-URL: #45986
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
@RafaelGSS RafaelGSS mentioned this pull request Jan 20, 2023
Merged
juanarbol pushed a commit that referenced this pull request Jan 26, 2023
@deokjinkim @juanarbol
doc: fix event.cancelBubble documentation
de09c54 
Setter of `event.cancelBubble` is a no-op if the value passed to it is
not `true`.

Refs: https://dom.spec.whatwg.org/#interface-event
PR-URL: #45986
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
@juanarbol juanarbol mentioned this pull request Jan 28, 2023
Merged
juanarbol pushed a commit that referenced this pull request Jan 31, 2023
@deokjinkim @juanarbol
doc: fix event.cancelBubble documentation
1ec14c2 
Setter of `event.cancelBubble` is a no-op if the value passed to it is
not `true`.

Refs: https://dom.spec.whatwg.org/#interface-event
PR-URL: #45986
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aduh95 aduh95 aduh95 approved these changes

@aymen94 aymen94 aymen94 approved these changes

@addaleax addaleax addaleax 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. commit-queue-failed An error occurred while landing this pull request using GitHub Actions. doc Issues and PRs related to the documentations. eventtarget Issues and PRs related to the EventTarget implementation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@deokjinkim @nodejs-github-bot @aduh95 @addaleax @aymen94