-
Notifications
You must be signed in to change notification settings - Fork 29k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: adjust slightly awkward wording in buffer.md #20037
Conversation
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, just left two suggestions.
@@ -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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might only be me, but the former description is somewhat more specific for me and therefore easier to understand.
Landed in c6b0059 |
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>
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>
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