Skip to content

Commit c6b0059

Browse files
committed
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: #20037 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Beth Griggs <[email protected]>
1 parent 8bcefd0 commit c6b0059

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

doc/api/buffer.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1003,7 +1003,8 @@ changes:
10031003
description: Additional parameters for specifying offsets are supported now.
10041004
-->
10051005

1006-
* `target` {Buffer|Uint8Array} A `Buffer` or [`Uint8Array`] to compare to.
1006+
* `target` {Buffer|Uint8Array} A `Buffer` or [`Uint8Array`] with which to
1007+
compare `buf`.
10071008
* `targetStart` {integer} The offset within `target` at which to begin
10081009
comparison. **Default:** `0`.
10091010
* `targetEnd` {integer} The offset with `target` at which to end comparison
@@ -1148,7 +1149,8 @@ changes:
11481149
description: The arguments can now be `Uint8Array`s.
11491150
-->
11501151

1151-
* `otherBuffer` {Buffer} A `Buffer` or [`Uint8Array`] to compare to.
1152+
* `otherBuffer` {Buffer} A `Buffer` or [`Uint8Array`] with which to compare
1153+
`buf`.
11521154
* Returns: {boolean}
11531155

11541156
Returns `true` if both `buf` and `otherBuffer` have exactly the same bytes,
@@ -1996,7 +1998,7 @@ console.log(copy);
19961998
added: v0.1.90
19971999
-->
19982000

1999-
* `encoding` {string} The character encoding to decode to. **Default:** `'utf8'`.
2001+
* `encoding` {string} The character encoding to use. **Default:** `'utf8'`.
20002002
* `start` {integer} The byte offset to start decoding at. **Default:** `0`.
20012003
* `end` {integer} The byte offset to stop decoding at (not inclusive).
20022004
**Default:** [`buf.length`].

0 commit comments

Comments
 (0)