From 520ef836c11a2301a25d8523ceee2ec8066ade84 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Thu, 20 Jun 2019 13:54:55 -0600 Subject: [PATCH] doc: remove "note that" from events.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Refs: https://github.com/nodejs/remark-preset-lint-node/pull/16 PR-URL: https://github.com/nodejs/node/pull/28329 Reviewed-By: Gus Caplan Reviewed-By: Trivikram Kamat Reviewed-By: Tobias Nießen Reviewed-By: Ruben Bridgewater --- doc/api/events.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/api/events.md b/doc/api/events.md index 37c8716e2c5e6c..1e41b10b8c7781 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -261,7 +261,7 @@ change affects *all* `EventEmitter` instances, including those created before the change is made. However, calling [`emitter.setMaxListeners(n)`][] still has precedence over `EventEmitter.defaultMaxListeners`. -Note that this is not a hard limit. The `EventEmitter` instance will allow +This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a "possible EventEmitter memory leak" has been detected. For any single `EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()` @@ -508,7 +508,7 @@ added: v0.1.26 Removes all listeners, or those of the specified `eventName`. -Note that it is bad practice to remove listeners added elsewhere in the code, +It is bad practice to remove listeners added elsewhere in the code, particularly when the `EventEmitter` instance was created by some other component or module (e.g. sockets or file streams). @@ -539,7 +539,7 @@ listener array. If any single listener has been added multiple times to the listener array for the specified `eventName`, then `removeListener()` must be called multiple times to remove each instance. -Note that once an event has been emitted, all listeners attached to it at the +Once an event has been emitted, all listeners attached to it at the time of emitting will be called in order. This implies that any `removeListener()` or `removeAllListeners()` calls *after* emitting and *before* the last listener finishes execution will not remove them from