From c6b00599f68b175d2967c1e46b12170ec308c50d Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sat, 14 Apr 2018 14:53:08 -0700 Subject: [PATCH] doc: adjust slightly awkward wording in buffer.md Minor re-wording of three sentences to make them slightly more natural. Ending sentences with prepositions is fine in many cases, but these three cases are a bit awkward. PR-URL: https://github.com/nodejs/node/pull/20037 Reviewed-By: Vse Mozhet Byt Reviewed-By: Trivikram Kamat Reviewed-By: Luigi Pinca Reviewed-By: Ruben Bridgewater Reviewed-By: James M Snell Reviewed-By: Beth Griggs --- doc/api/buffer.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/api/buffer.md b/doc/api/buffer.md index b971021416a..8bd82d6206a 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -1003,7 +1003,8 @@ changes: description: Additional parameters for specifying offsets are supported now. --> -* `target` {Buffer|Uint8Array} A `Buffer` or [`Uint8Array`] to compare to. +* `target` {Buffer|Uint8Array} A `Buffer` or [`Uint8Array`] with which to + compare `buf`. * `targetStart` {integer} The offset within `target` at which to begin comparison. **Default:** `0`. * `targetEnd` {integer} The offset with `target` at which to end comparison @@ -1148,7 +1149,8 @@ changes: description: The arguments can now be `Uint8Array`s. --> -* `otherBuffer` {Buffer} A `Buffer` or [`Uint8Array`] to compare to. +* `otherBuffer` {Buffer} A `Buffer` or [`Uint8Array`] with which to compare + `buf`. * Returns: {boolean} Returns `true` if both `buf` and `otherBuffer` have exactly the same bytes, @@ -1996,7 +1998,7 @@ console.log(copy); added: v0.1.90 --> -* `encoding` {string} The character encoding to decode to. **Default:** `'utf8'`. +* `encoding` {string} The character encoding to use. **Default:** `'utf8'`. * `start` {integer} The byte offset to start decoding at. **Default:** `0`. * `end` {integer} The byte offset to stop decoding at (not inclusive). **Default:** [`buf.length`].