doc: clarify requireManualDestroy option

Fixes: #32409 PR-URL: #32514 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Vladimir de Turckheim <[email protected]>
nodejs · Apr 11, 2020 · 34074aa · 34074aa
1 parent a1bb93a
commit 34074aa
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md
@@ -681,10 +681,10 @@ asyncResource.triggerAsyncId();
 * `options` {Object}
   * `triggerAsyncId` {number} The ID of the execution context that created this
   async event. **Default:** `executionAsyncId()`.
-  * `requireManualDestroy` {boolean} Disables automatic `emitDestroy` when the
-  object is garbage collected. This usually does not need to be set (even if
-  `emitDestroy` is called manually), unless the resource's `asyncId` is
-  retrieved and the sensitive API's `emitDestroy` is called with it.
+  * `requireManualDestroy` {boolean} If set to `true`, disables `emitDestroy`
+  when the object is garbage collected. This usually does not need to be set
+  (even if `emitDestroy` is called manually), unless the resource's `asyncId`
+  is retrieved and the sensitive API's `emitDestroy` is called with it.
   **Default:** `false`.
 
 Example usage: