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.

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

doc: use consistent event name parameter #5850

Closed

Conversation

benjamingr
Copy link
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.

@benjamingr benjamingr added the doc Issues and PRs related to the documentations. label Mar 22, 2016
@jasnell
Copy link
Member

jasnell commented Mar 22, 2016

LGTM

@mscdex mscdex added the events Issues and PRs related to the events subsystem / EventEmitter. label Mar 22, 2016
Adds a **one time** `listener` function for the `event`. This listener is
invoked only the next time `event` is triggered, after which it is removed.
Adds a **one time** `listener` function for the event named `eventName`. This
listener is invoked only the next time `event` is triggered, after which it is removed.
Copy link
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
Copy link
Contributor

cjihrig commented Mar 22, 2016

LGTM with a couple comments.

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
Copy link
Member Author

Comments addressed, thanks.

@Fishrock123
Copy link
Contributor

seems fine to me at a glance

@benjamingr
Copy link
Member Author

Landed in ea52f47 . Cheers.

benjamingr added a commit that referenced this pull request Mar 24, 2016
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 <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
@benjamingr benjamingr closed this Mar 24, 2016
evanlucas pushed a commit that referenced this pull request Mar 30, 2016
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 <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
MylesBorins pushed a commit that referenced this pull request Mar 30, 2016
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 <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
MylesBorins pushed a commit that referenced this pull request Mar 30, 2016
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 <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
evanlucas pushed a commit that referenced this pull request Mar 31, 2016
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 <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. events Issues and PRs related to the events subsystem / EventEmitter.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants