Skip to content

doc: missing argument types for events methods#11802

Closed
ameliavoncat wants to merge 1 commit intonodejs:masterfrom
ameliavoncat:events-argument-types
Closed

doc: missing argument types for events methods#11802
ameliavoncat wants to merge 1 commit intonodejs:masterfrom
ameliavoncat:events-argument-types

Conversation

@ameliavoncat
Copy link
Contributor

@ameliavoncat ameliavoncat commented Mar 11, 2017

Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

documentation

Description of changes

Adds missing argument types to the docs for event methods

Issue

@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 Mar 11, 2017
mscdex
mscdex reviewed Mar 11, 2017
View reviewed changes
doc/api/events.md Outdated
Copy link
Contributor

@mscdex mscdex Mar 11, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

The type here isn't correct. It can be zero or more of any kind of values. I'm not sure if we've yet "standardized" on what term to use as an 'any' type.

mscdex
mscdex reviewed Mar 11, 2017
View reviewed changes
doc/api/events.md Outdated
Copy link
Contributor

@mscdex mscdex Mar 11, 2017

Choose a reason for hiding this comment

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

We're more lax than this. We basically accept any value, it's just that (currently) it will be converted to a string before being used. So for example numbers, booleans, functions (the function's source will be used as the event name), etc. all work.

mscdex
mscdex reviewed Mar 11, 2017
View reviewed changes
doc/api/events.md Outdated
Copy link
Contributor

@mscdex mscdex Mar 11, 2017

Choose a reason for hiding this comment

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

I think it may make more sense to be more specific here and say 'integer.'

@ameliavoncat ameliavoncat force-pushed the events-argument-types branch from 81c7f32 to f581702 Compare March 11, 2017 16:20
@mscdex
Copy link
Contributor

mscdex commented Mar 12, 2017

LGTM

jasnell pushed a commit that referenced this pull request Mar 15, 2017
@ameliavoncat @jasnell
doc: missing argument types for events methods
38ba0c2 
Refs: #9399
PR-URL: #11802
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
@jasnell
Copy link
Member

jasnell commented Mar 15, 2017

Landed in 38ba0c2. Thank you! :-)

@jasnell jasnell closed this Mar 15, 2017
italoacasas pushed a commit to italoacasas/node that referenced this pull request Mar 20, 2017
@ameliavoncat
doc: missing argument types for events methods
75fcf53 
Refs: nodejs#9399
PR-URL: nodejs#11802
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
@italoacasas italoacasas mentioned this pull request Mar 20, 2017
Merged
jungx098 pushed a commit to jungx098/node that referenced this pull request Mar 21, 2017
@ameliavoncat @jungx098
doc: missing argument types for events methods
3b7c9e0 
Refs: nodejs#9399
PR-URL: nodejs#11802
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
@MylesBorins
Copy link
Contributor

MylesBorins commented Apr 18, 2017

This does not land cleanly in LTS. Please feel free to manually backport. Please also feel free to replace the backport request label with do-not-land if it shouldn't land

This was referenced Mar 7, 2020
Open
Open
Open
Open
Open
Open
@adamlaska adamlaska mentioned this pull request Nov 30, 2023
Open
@ryan-ally ryan-ally mentioned this pull request Nov 30, 2023
Open
This was referenced Nov 30, 2023
Open
Open
This was referenced Nov 30, 2023
Open
Open
@aliscco aliscco mentioned this pull request Dec 1, 2023
Open
@leonardoadame leonardoadame mentioned this pull request Dec 1, 2023
Open
This was referenced Dec 1, 2023
Open
Open
This was referenced Dec 1, 2023
Open
Open
This was referenced Dec 1, 2023
Open
Open
@adamlaska adamlaska mentioned this pull request Dec 2, 2023
Open
@aliscco aliscco mentioned this pull request Dec 2, 2023
Open
@leonardoadame leonardoadame mentioned this pull request Dec 2, 2023
Open
This was referenced Dec 2, 2023
Open
Open
Open
Open
@leonardoadame leonardoadame mentioned this pull request Dec 2, 2023
Open
This was referenced Dec 2, 2023
Open
Open
Open
This was referenced Dec 2, 2023
Open
Open
This was referenced Dec 2, 2023
Open
Open
This was referenced Dec 3, 2023
Open
Open
Open
@aliscco aliscco mentioned this pull request Dec 3, 2023
Open
@leonardoadame leonardoadame mentioned this pull request Dec 3, 2023
Open
@aliscco aliscco mentioned this pull request Dec 3, 2023
Open
@leonardoadame leonardoadame mentioned this pull request Dec 5, 2023
Open
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

@cjihrig cjihrig cjihrig approved these changes

+1 more reviewer

@mscdex mscdex mscdex left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

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.

6 participants

@ameliavoncat @mscdex @jasnell @MylesBorins @cjihrig @nodejs-github-bot