doc: modify param description for end(),write() in StringDecoder#49285
Merged
nodejs-github-bot merged 1 commit intonodejs:mainfrom Aug 24, 2023
Merged
doc: modify param description for end(),write() in StringDecoder#49285nodejs-github-bot merged 1 commit intonodejs:mainfrom
StringDecoder#49285nodejs-github-bot merged 1 commit intonodejs:mainfrom
Conversation
nodejs-github-bot
added
doc
mscdex
reviewed
Aug 22, 2023
doc/api/string_decoder.md
Outdated
| --> | ||
|
|
||
| * `buffer` {Buffer|TypedArray|DataView} A `Buffer`, or `TypedArray`, or | ||
| * `buffer` {string|Buffer|TypedArray|DataView} A `Buffer`, or `TypedArray`, or |
Contributor
There was a problem hiding this comment.
The parameter description that follows also needs updating.
Contributor
Author
There was a problem hiding this comment.
@mscdex Thank you for your comment. I updated it.
mscdex
reviewed
Aug 22, 2023
doc/api/string_decoder.md
Outdated
| --> | ||
|
|
||
| * `buffer` {Buffer|TypedArray|DataView} A `Buffer`, or `TypedArray`, or | ||
| * `buffer` {string|Buffer|TypedArray|DataView} A `Buffer`, or `TypedArray`, or |
pluris
force-pushed
the
fix/argument_string_decoder
branch
from
13c02ac to
9ab677c
Compare
Member
|
Typo in commit message, |
pluris
changed the title
StringDecoderStringDecoder
Contributor
Author
|
@VoltrexKeyva Hi, Thank you. I fixed it. |
mscdex
reviewed
Aug 23, 2023
doc/api/string_decoder.md
Outdated
|
|
||
| * `buffer` {Buffer|TypedArray|DataView} A `Buffer`, or `TypedArray`, or | ||
| `DataView` containing the bytes to decode. | ||
| * `buffer` {string|Buffer|TypedArray|DataView} A `string`, or `Buffer`, or |
Contributor
There was a problem hiding this comment.
Perhaps we can just shorten these descriptions down to simply:
The bytes to decode.
as duplicating the types is unnecessary
Contributor
Author
There was a problem hiding this comment.
That's a great comment! I also wanted to briefly explain the types.
lpinca
approved these changes
Aug 23, 2023
Contributor
@pluris First commit(not PR)'s typo(decription -> description) is not fixed yet. Could you fix typo after squashing 3 commits to 1? |
pluris
force-pushed
the
fix/argument_string_decoder
branch
from
ab493a8 to
0eca1b7
Compare
Contributor
Author
|
@deokjinkim Hi. I guess I misunderstood the comment. I'll edit the message as I change the commits to 1. 😓 |
deokjinkim
approved these changes
Aug 24, 2023
deokjinkim
added
author ready
nodejs-github-bot
removed
the
commit-queue
Collaborator
|
Landed in a494ef6 |
UlisesGascon
pushed a commit
that referenced
this pull request
Sep 10, 2023
PR-URL: #49285 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
Merged
alexfernandez
pushed a commit
to alexfernandez/node
that referenced
this pull request
Nov 1, 2023
PR-URL: nodejs#49285 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
targos
pushed a commit
that referenced
this pull request
Nov 27, 2023
PR-URL: #49285 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
sercher
added a commit
to sercher/graaljs
that referenced
this pull request
Apr 25, 2024
PR-URL: nodejs/node#49285 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
sercher
added a commit
to sercher/graaljs
that referenced
this pull request
Apr 25, 2024
PR-URL: nodejs/node#49285 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
According to the following js code,
stringis also included in possible arguments.Therefore, it seems that the
stringis missing in the API description, so I added it.node/lib/string_decoder.js
Lines 91 to 95 in 62b2cf3
node/lib/string_decoder.js
Lines 112 to 115 in 62b2cf3