Skip to content

doc: use consistent event name parameter - #5850

Closed
benjamingr wants to merge 1 commit into
nodejs:masterfrom
benjamingr:doc-events-consistent-param
Closed

doc: use consistent event name parameter#5850
benjamingr wants to merge 1 commit into
nodejs:masterfrom
benjamingr:doc-events-consistent-param

Conversation

@benjamingr

@benjamingrbenjamingr commented Mar 22, 2016

Copy link
Copy Markdown
Member

Description of change

Implementing the suggestion in #4554 this pull request renames the parameter name in all the places that accept an event name as a parameter.

Previously, the parameter has been called event or type. Now as suggested it is consistently called eventName.

@benjamingrbenjamingr added the doc Issues and PRs related to the documentations. label Mar 22, 2016
@jasnell

jasnell commented Mar 22, 2016

Copy link
Copy Markdown
Member

LGTM

@mscdexmscdex added the events Issues and PRs related to the events subsystem / EventEmitter. label Mar 22, 2016
cjihrig
cjihrig reviewed Mar 22, 2016
View reviewed changes
Comment threaddoc/api/events.markdown Outdated

@cjihrigcjihrigMar 22, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should this be eventName?

@cjihrig

cjihrig commented Mar 22, 2016

Copy link
Copy Markdown
Contributor

LGTM with a couple comments.

@benjamingr
doc: use consistent event name parameter
111e403
Implementing the suggestion in
nodejs#4554 this pull request renames
the parameter name in all the places that accept an event name as a parameter.
Previously, the parameter has been called `event` or `type`. Now as suggested
it is consistently called `eventName`.
PR-URL:
Reviewed-By:
Reviewed-By:
@benjamingr
benjamingrforce-pushed the doc-events-consistent-param branch from ab62c45 to 111e403CompareMarch 22, 2016 23:56
@benjamingr

benjamingr commented Mar 22, 2016

Copy link
Copy Markdown
MemberAuthor

Comments addressed, thanks.

@Fishrock123

Fishrock123 commented Mar 23, 2016

Copy link
Copy Markdown
Contributor

seems fine to me at a glance

@benjamingr

benjamingr commented Mar 24, 2016

Copy link
Copy Markdown
MemberAuthor

Landed in ea52f47 . Cheers.

benjamingr added a commit that referenced this pull request Mar 24, 2016
@benjamingr
doc: use consistent event name parameter
ea52f47
Implementing the suggestion in
#4554 this pull request renames
the parameter name in all the places that accept an event name as a parameter.
Previously, the parameter has been called `event` or `type`. Now as suggested
it is consistently called `eventName`.
PR-URL: #5850
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
evanlucas pushed a commit that referenced this pull request Mar 30, 2016
@benjamingr@evanlucas
doc: use consistent event name parameter
fc6513d
Implementing the suggestion in
#4554 this pull request renames
the parameter name in all the places that accept an event name as a parameter.
Previously, the parameter has been called `event` or `type`. Now as suggested
it is consistently called `eventName`.
PR-URL: #5850
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 30, 2016
@benjamingrMyles Borins
doc: use consistent event name parameter
3c1ed84
Implementing the suggestion in
#4554 this pull request renames
the parameter name in all the places that accept an event name as a parameter.
Previously, the parameter has been called `event` or `type`. Now as suggested
it is consistently called `eventName`.
PR-URL: #5850
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 30, 2016
@benjamingrMyles Borins
doc: use consistent event name parameter
7c83702
Implementing the suggestion in
#4554 this pull request renames
the parameter name in all the places that accept an event name as a parameter.
Previously, the parameter has been called `event` or `type`. Now as suggested
it is consistently called `eventName`.
PR-URL: #5850
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
@evanlucasevanlucas mentioned this pull request Mar 31, 2016
Closed
evanlucas pushed a commit that referenced this pull request Mar 31, 2016
@benjamingr@evanlucas
doc: use consistent event name parameter
2977839
Implementing the suggestion in
#4554 this pull request renames
the parameter name in all the places that accept an event name as a parameter.
Previously, the parameter has been called `event` or `type`. Now as suggested
it is consistently called `eventName`.
PR-URL: #5850
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

docIssues and PRs related to the documentations.eventsIssues 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

@benjamingr@jasnell@cjihrig@Fishrock123@mscdex@MylesBorins