doc: adjust slightly awkward wording in buffer.md #20037
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
nodejs-github-bot
added
buffer
vsemozhetbyt
approved these changes
Apr 14, 2018
vsemozhetbyt
added
the
fast-track
Trott
added
the
author ready
trivikr
approved these changes
Apr 15, 2018
lpinca
approved these changes
Apr 15, 2018
BridgeAR
approved these changes
Apr 15, 2018
| @@ -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 | |||
There was a problem hiding this comment.
We might want to rename target to otherBuffer or rename otherBuffer to target down below. That way it is more consistent.
| @@ -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'`. | |||
There was a problem hiding this comment.
It might only be me, but the former description is somewhat more specific for me and therefore easier to understand.
jasnell
approved these changes
Apr 16, 2018
BethGriggs
approved these changes
Apr 16, 2018
|
Landed in c6b0059 |
Trott
added a commit
to Trott/io.js
that referenced
this pull request
Apr 17, 2018
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: nodejs#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>
jasnell
pushed a commit
that referenced
this pull request
Apr 19, 2018
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 <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>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Checklist