FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: modify param description for end(),write() in `StringDecoder` by pluris · Pull Request #49285 · nodejs/node · GitHub

/ node Public

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
ConversationCommits (1)ChecksFiles changed
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 commented Aug 22, 2023

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.

node/lib/string_decoder.js

Lines 91 to 95 in 62b2cf3

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

node/lib/string_decoder.js

Lines 112 to 115 in 62b2cf3

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

nodejs-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
mscdex reviewed Aug 22, 2023
View reviewed changes
Comment thread doc/api/string_decoder.md Outdated

mscdex Aug 22, 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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

The parameter description that follows also needs updating.

pluris Aug 22, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

mscdex reviewed Aug 22, 2023
View reviewed changes
Comment thread doc/api/string_decoder.md Outdated

mscdex Aug 22, 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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Ditto

pluris force-pushed the fix/argument_string_decoder branch from 13c02ac to 9ab677c Compare August 22, 2023 16:12

VoltrexKeyva commented Aug 23, 2023

Copy link
Copy Markdown
Contributor

Typo in commit message, decription to description.

pluris changed the title doc: modify param decription for end(),write() in StringDecoder doc: modify param description for end(),write() in StringDecoder Aug 23, 2023

pluris commented Aug 23, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

@VoltrexKeyva Hi, Thank you. I fixed it.

mscdex reviewed Aug 23, 2023
View reviewed changes
Comment thread doc/api/string_decoder.md Outdated

mscdex Aug 23, 2023 •
edited
Loading

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Perhaps we can just shorten these descriptions down to simply:

The bytes to decode.

as duplicating the types is unnecessary

pluris Aug 23, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

deokjinkim commented Aug 24, 2023

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 force-pushed the fix/argument_string_decoder branch from ab493a8 to 0eca1b7 Compare August 24, 2023 13:42

pluris commented Aug 24, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

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

deokjinkim added author ready PRs that have at least one approval, no outstanding review comments, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. labels Aug 24, 2023
nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Aug 24, 2023
nodejs-github-bot merged commit a494ef6 into nodejs:main Aug 24, 2023

nodejs-github-bot commented Aug 24, 2023

Copy link
Copy Markdown
Collaborator

Landed in a494ef6

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
doc: modify param description for end(),write() in StringDecoder
fefbdb9 
PR-URL: #49285
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
UlisesGascon mentioned this pull request Sep 10, 2023
Merged
targos pushed a commit that referenced this pull request Nov 27, 2023
doc: modify param description for end(),write() in StringDecoder
9ca85b5 
PR-URL: #49285
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Deokjin Kim <deokjin81.kim@gmail.com>
targos mentioned this pull request Nov 28, 2023
Merged
sercher added a commit to sercher/graaljs that referenced this pull request Apr 25, 2024
doc: modify param description for end(),write() in
8c37f76 
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
doc: modify param description for end(),write() in
51766a7 
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

lpinca lpinca approved these changes
deokjinkim deokjinkim approved these changes
+1 more reviewer
mscdex mscdex left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no outstanding review comments, and a CI started. doc Issues and PRs related to the documentations. string_decoder Issues and PRs related to the string_decoder subsystem.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

Back | FazBrowse Home | New Git URL