diff options
author | Rich Trott <rtrott@gmail.com> | 2019-10-23 21:28:42 -0700 |
---|---|---|
committer | Rich Trott <rtrott@gmail.com> | 2019-10-26 08:39:41 -0700 |
commit | 10040500da6af33b602e35c3f3bbe28cf76c4c4a (patch) | |
tree | 69c2af94709de9ef7022c41423c0f618eb0d5e0a /doc/api/deprecations.md | |
parent | 6858c7e3e7c30986d68a683d3d5e4ede4c0b529f (diff) | |
download | android-node-v8-10040500da6af33b602e35c3f3bbe28cf76c4c4a.tar.gz android-node-v8-10040500da6af33b602e35c3f3bbe28cf76c4c4a.tar.bz2 android-node-v8-10040500da6af33b602e35c3f3bbe28cf76c4c4a.zip |
doc: remove dashes
The use of dashes -- in general, but especially in our docs -- can be
problematic. It is used inconsistently and there is always another form
of punctuation that is as good or better for the situation. In an effort
to reduce the number of variations we use to display the same types of
information, remove the various uses of dashes from the documentation.
PR-URL: https://github.com/nodejs/node/pull/30101
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/deprecations.md')
-rw-r--r-- | doc/api/deprecations.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index ca832060e1..50303baa78 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -141,17 +141,17 @@ API usability issues that can lead to accidental security issues. As an alternative, use one of the following methods of constructing `Buffer` objects: -* [`Buffer.alloc(size[, fill[, encoding]])`][alloc] - Create a `Buffer` with +* [`Buffer.alloc(size[, fill[, encoding]])`][alloc]: Create a `Buffer` with *initialized* memory. -* [`Buffer.allocUnsafe(size)`][alloc_unsafe_size] - Create a `Buffer` with +* [`Buffer.allocUnsafe(size)`][alloc_unsafe_size]: Create a `Buffer` with *uninitialized* memory. -* [`Buffer.allocUnsafeSlow(size)`][] - Create a `Buffer` with *uninitialized* +* [`Buffer.allocUnsafeSlow(size)`][]: Create a `Buffer` with *uninitialized* memory. -* [`Buffer.from(array)`][] - Create a `Buffer` with a copy of `array` +* [`Buffer.from(array)`][]: Create a `Buffer` with a copy of `array` * [`Buffer.from(arrayBuffer[, byteOffset[, length]])`][from_arraybuffer] - Create a `Buffer` that wraps the given `arrayBuffer`. -* [`Buffer.from(buffer)`][] - Create a `Buffer` that copies `buffer`. -* [`Buffer.from(string[, encoding])`][from_string_encoding] - Create a `Buffer` +* [`Buffer.from(buffer)`][]: Create a `Buffer` that copies `buffer`. +* [`Buffer.from(string[, encoding])`][from_string_encoding]: Create a `Buffer` that copies `string`. Without `--pending-deprecation`, runtime warnings occur only for code not in |