Skip to content

doc: modify param description for end(),write() in StringDecoder - #49285

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
pluris:fix/argument_string_decoder
Aug 24, 2023
Merged

doc: modify param description for end(),write() in StringDecoder#49285
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
pluris:fix/argument_string_decoder

Conversation

@pluris

Copy link
Copy Markdown
Contributor

According to the following js code, string is also included in possible arguments.
Therefore, it seems that the string is missing in the API description, so I added it.

* @param {string | Buffer | TypedArray | DataView} buf
* @returns {string}
* @throws {TypeError} Throws when buf is not in one of supported types
*/
StringDecoder.prototype.write=functionwrite(buf){

* @param {string | Buffer | TypedArray | DataView} [buf]
* @returns {string}
*/
StringDecoder.prototype.end=functionend(buf){

@nodejs-github-botnodejs-github-bot added doc Issues and PRs related to the documentations. string_decoder Issues and PRs related to the string_decoder subsystem. labels Aug 22, 2023
Comment threaddoc/api/string_decoder.md Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The parameter description that follows also needs updating.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mscdex Thank you for your comment. I updated it.

Comment threaddoc/api/string_decoder.md Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto

@pluris
plurisforce-pushed the fix/argument_string_decoder branch from 13c02ac to 9ab677cCompareAugust 22, 2023 16:12
@VoltrexKeyva

Copy link
Copy Markdown
Contributor

Typo in commit message, decription to description.

@plurispluris changed the title doc: modify param decription for end(),write() in StringDecoderdoc: modify param description for end(),write() in StringDecoderAug 23, 2023
@pluris

pluris commented Aug 23, 2023

Copy link
Copy Markdown
ContributorAuthor

@VoltrexKeyva Hi, Thank you. I fixed it.

Comment threaddoc/api/string_decoder.md Outdated

@mscdexmscdexAug 23, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we can just shorten these descriptions down to simply:

The bytes to decode.

as duplicating the types is unnecessary

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a great comment! I also wanted to briefly explain the types.

@deokjinkim

Copy link
Copy Markdown
Contributor

@VoltrexKeyva Hi, Thank you. I fixed it.

@pluris First commit(not PR)'s typo(decription -> description) is not fixed yet. Could you fix typo after squashing 3 commits to 1?

@pluris
plurisforce-pushed the fix/argument_string_decoder branch from ab493a8 to 0eca1b7CompareAugust 24, 2023 13:42
@pluris

pluris commented Aug 24, 2023

Copy link
Copy Markdown
ContributorAuthor

@deokjinkim Hi. I guess I misunderstood the comment. I'll edit the message as I change the commits to 1. 😓

@deokjinkimdeokjinkim added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. labels Aug 24, 2023
@nodejs-github-botnodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Aug 24, 2023
@nodejs-github-bot
nodejs-github-bot merged commit a494ef6 into nodejs:mainAug 24, 2023
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in a494ef6

@pluris
pluris deleted the fix/argument_string_decoder branch August 30, 2023 16:12
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>
@UlisesGasconUlisesGascon mentioned this pull request Sep 10, 2023
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>
@targostargos mentioned this pull request Nov 28, 2023
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>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.docIssues and PRs related to the documentations.string_decoderIssues and PRs related to the string_decoder subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@pluris@VoltrexKeyva@deokjinkim@nodejs-github-bot@mscdex@lpinca