1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: adjust slightly awkward wording in buffer.md

Browse Source 
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>
This commit is contained in:
Rich Trott 2018-04-14 14:53:08 -07:00
parent 8bcefd069a
commit c6b00599f6
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/api/buffer.md
View File

@ -1003,7 +1003,8 @@ changes:
description: Additional parameters for specifying offsets are supported now. 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 * `targetStart` {integer} The offset within `target` at which to begin
comparison. **Default:** `0`. comparison. **Default:** `0`.
* `targetEnd` {integer} The offset with `target` at which to end comparison * `targetEnd` {integer} The offset with `target` at which to end comparison
@ -1148,7 +1149,8 @@ changes:
description: The arguments can now be `Uint8Array`s. 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: {boolean}
Returns `true` if both `buf` and `otherBuffer` have exactly the same bytes, Returns `true` if both `buf` and `otherBuffer` have exactly the same bytes,
@ -1996,7 +1998,7 @@ console.log(copy);
added: v0.1.90 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`. * `start` {integer} The byte offset to start decoding at. **Default:** `0`.
* `end` {integer} The byte offset to stop decoding at (not inclusive). * `end` {integer} The byte offset to stop decoding at (not inclusive).
**Default:** [`buf.length`]. **Default:** [`buf.length`].