From 344c5c454dd3792502e59ef715cb4ed2ee72ac24 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sun, 29 Sep 2019 19:30:44 -0700 Subject: doc: clarify --pending-deprecation effects on Buffer() usage Refs: https://github.com/nodejs/node/pull/29725#issuecomment-535723152 PR-URL: https://github.com/nodejs/node/pull/29769 Reviewed-By: Anna Henningsen Reviewed-By: Colin Ihrig Reviewed-By: James M Snell Reviewed-By: Luigi Pinca Reviewed-By: Michael Dawson Reviewed-By: Ruben Bridgewater --- doc/api/deprecations.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index 46d2467c72..1082e76be2 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -154,9 +154,10 @@ objects: * [`Buffer.from(string[, encoding])`][from_string_encoding] - Create a `Buffer` that copies `string`. -As of v10.0.0, a deprecation warning is printed at runtime when -`--pending-deprecation` is used or when the calling code is -outside `node_modules` in order to better target developers, rather than users. +Without `--pending-deprecation`, runtime warnings occur only for code not in +`node_modules`. This means there will not be deprecation warnings for +`Buffer()` usage in dependencies. With `--pending-deprecation`, a runtime +warning results no matter where the `Buffer()` usage occurs. ### DEP0006: child\_process options.customFds -- cgit v1.2.3