summaryrefslogtreecommitdiff
path: root/doc/api/buffer.md
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2018-03-23 15:02:35 -0700
committerRich Trott <rtrott@gmail.com>2018-03-26 16:19:37 -0700
commitae120dbfd5e32058f4d136f6b56fa936fac4c305 (patch)
treed086fe27776aa42765ed3dc3b15b8f9e52b2ca5e /doc/api/buffer.md
parent400faf5a3a2605977e613d04578e800b81b00a79 (diff)
downloadandroid-node-v8-ae120dbfd5e32058f4d136f6b56fa936fac4c305.tar.gz
android-node-v8-ae120dbfd5e32058f4d136f6b56fa936fac4c305.tar.bz2
android-node-v8-ae120dbfd5e32058f4d136f6b56fa936fac4c305.zip
doc: fix run-on sentence in buffer.md
PR-URL: https://github.com/nodejs/node/pull/19567 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Diffstat (limited to 'doc/api/buffer.md')
-rw-r--r--doc/api/buffer.md9
1 files changed, 4 insertions, 5 deletions
diff --git a/doc/api/buffer.md b/doc/api/buffer.md
index 72c7c67b74..2897a32f96 100644
--- a/doc/api/buffer.md
+++ b/doc/api/buffer.md
@@ -68,11 +68,10 @@ differently based on what arguments are provided:
* Passing an [`ArrayBuffer`] or a [`SharedArrayBuffer`] returns a `Buffer` that
shares allocated memory with the given array buffer.
-Because the behavior of `new Buffer()` changes significantly based on the type
-of value passed as the first argument, applications that do not properly
-validate the input arguments passed to `new Buffer()`, or that fail to
-appropriately initialize newly allocated `Buffer` content, can inadvertently
-introduce security and reliability issues into their code.
+Because the behavior of `new Buffer()` is different depending on the type of the
+first argument, security and reliability issues can be inadvertantly introduced
+into applications when argument validation or `Buffer` initialization are not
+performed.
To make the creation of `Buffer` instances more reliable and less error prone,
the various forms of the `new Buffer()` constructor have been **deprecated**