summaryrefslogtreecommitdiff
path: root/doc/api/buffer.md
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2018-04-14 14:53:08 -0700
committerRich Trott <rtrott@gmail.com>2018-04-17 14:43:43 -0700
commitc6b00599f68b175d2967c1e46b12170ec308c50d (patch)
tree96c0308650a3215bcbb1be84ccb1f452a0709b4f /doc/api/buffer.md
parent8bcefd069aa965b4e33d72431cc8e4acff10fcac (diff)
downloadandroid-node-v8-c6b00599f68b175d2967c1e46b12170ec308c50d.tar.gz
android-node-v8-c6b00599f68b175d2967c1e46b12170ec308c50d.tar.bz2
android-node-v8-c6b00599f68b175d2967c1e46b12170ec308c50d.zip
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 <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Diffstat (limited to 'doc/api/buffer.md')
-rw-r--r--doc/api/buffer.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/api/buffer.md b/doc/api/buffer.md
index b971021416..8bd82d6206 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`].