From d5340526fdde06653330a63b73791d81d2585636 Mon Sep 17 00:00:00 2001 From: cjihrig Date: Sun, 31 May 2020 16:20:20 -0400 Subject: [PATCH 1/2] doc: remove "it is important" MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit In the spirit of #30108, remove the use of "it is important" in the new EventTarget docs. PR-URL: https://github.com/nodejs/node/pull/33678 Reviewed-By: James M Snell Reviewed-By: Anna Henningsen Reviewed-By: Luigi Pinca Reviewed-By: Juan José Arboleda Reviewed-By: Ruben Bridgewater --- doc/api/events.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/doc/api/events.md b/doc/api/events.md index 1f25bb440122a0..7423ae7adb194a 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -974,9 +974,8 @@ There are two key differences between the Node.js `EventTarget` and the The `NodeEventTarget` object implements a modified subset of the `EventEmitter` API that allows it to closely *emulate* an `EventEmitter` in -certain situations. It is important to understand, however, that an -`NodeEventTarget` is *not* an instance of `EventEmitter` and cannot be used in -place of an `EventEmitter` in most cases. +certain situations. A `NodeEventTarget` is *not* an instance of `EventEmitter` +and cannot be used in place of an `EventEmitter` in most cases. 1. Unlike `EventEmitter`, any given `listener` can be registered at most once per event `type`. Attempts to register a `listener` multiple times will be From 16eaacfd2bad09a9bdada1908ea58657cce12ead Mon Sep 17 00:00:00 2001 From: cjihrig Date: Sun, 31 May 2020 16:30:41 -0400 Subject: [PATCH 2/2] doc: use consistent Default: in events MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The API docs have been migrating to **Default:** when providing default values. This commit updates the events documentation page for consistency. PR-URL: https://github.com/nodejs/node/pull/33678 Reviewed-By: James M Snell Reviewed-By: Anna Henningsen Reviewed-By: Luigi Pinca Reviewed-By: Juan José Arboleda Reviewed-By: Ruben Bridgewater --- doc/api/events.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/api/events.md b/doc/api/events.md index 7423ae7adb194a..6929e8fa9cfbc9 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -244,7 +244,7 @@ It supports the following option: * `captureRejections` {boolean} It enables [automatic capturing of promise rejection][capturerejections]. - Default: `false`. + **Default:** `false`. ### Event: `'newListener'`