Skip to content
This repository has been archived by the owner on Apr 22, 2023. It is now read-only.

events.markdown document improvements #8911

Closed
wants to merge 2 commits into from

Conversation

jasnell
Copy link
Member

@jasnell jasnell commented Dec 19, 2014

Improvements to events.markdown documentation per #8853 (same fix as before but rebased on joyent/v0.10

Improvements to events.markdown documentation per
nodejs#8853 (same fix as before but
rebased on joyent/v0.10
This event is emitted any time someone adds a new listener. It is unspecified
if `listener` is in the list returned by `emitter.listeners(event)`.
This event is emitted any time a listener is added. When this event is triggered,
the listener may not yet have been added to the array of listeners for the `event`.

Choose a reason for hiding this comment

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

I think this wording is a vast improvement.

The same change should be applied to removeListener, which has the same awful wording, and would benefit from your cleanup.

With that addition, I'd be ++++.

Copy link
Member Author

Choose a reason for hiding this comment

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

@sam-github
Copy link

+1 from me, looks much improved.

tjfontaine pushed a commit that referenced this pull request Dec 22, 2014
Clarify that adding or removing a listener is not idempotent.

RE: #8853
PR: #8911
PR-URL: #8911
Signed-off-by: Timothy J Fontaine <tjfontaine@gmail.com>
@tjfontaine
Copy link

Thanks, landed in 4853639 with a reworded commit message.

btw, can you make sure your commits line up with our style https://github.com/joyent/node/blob/master/CONTRIBUTING.md#commit

@tjfontaine tjfontaine closed this Dec 22, 2014
@jasnell
Copy link
Member Author

jasnell commented Dec 22, 2014

+1 will do

jasnell added a commit to jasnell/node-joyent that referenced this pull request Jan 5, 2015
Clarify that adding or removing a listener is not idempotent.

RE: nodejs#8853
PR: nodejs#8911
PR-URL: nodejs#8911
Signed-off-by: Timothy J Fontaine <tjfontaine@gmail.com>
jasnell added a commit to jasnell/node-joyent that referenced this pull request Jan 5, 2015
Clarify that adding or removing a listener is not idempotent.

RE: nodejs#8853
PR: nodejs#8911
PR-URL: nodejs#8911
Signed-off-by: Timothy J Fontaine <tjfontaine@gmail.com>
piscisaureus pushed a commit to piscisaureus/node2 that referenced this pull request Jan 10, 2015
Clarify that adding or removing a listener is not idempotent.

PR-URL: nodejs/node-v0.x-archive#8911
Signed-off-by: Timothy J Fontaine <tjfontaine@gmail.com>

Cherry-picked-from: nodejs/node-v0.x-archive@4853639
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants