GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — doc: modify param description for end(),write() in `StringDecoder` by pluris · Pull Request #49285 · nodejs/node

Conversation

@pluris

@pluris 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) {

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
bricss reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to Node.js documentation. string_decoder Issues and PRs related to the string_decoder subsystem. labels Aug 22, 2023
mscdex
mscdex reviewed Aug 22, 2023
View reviewed changes
Comment thread doc/api/string_decoder.md Outdated

@mscdex mscdex Aug 22, 2023

Copy link
Copy Markdown
Contributor

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.

The parameter description that follows also needs updating.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
pluris reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

@pluris pluris Aug 22, 2023

Copy link
Copy Markdown
Contributor Author

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.

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
mscdex
mscdex reviewed Aug 22, 2023
View reviewed changes
Comment thread doc/api/string_decoder.md Outdated

@mscdex mscdex Aug 22, 2023

Copy link
Copy Markdown
Contributor

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.

Ditto

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
pluris reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@pluris
pluris force-pushed the fix/argument_string_decoder branch from 13c02ac to 9ab677c Compare August 22, 2023 16:12
@VoltrexKeyva

VoltrexKeyva commented Aug 23, 2023

Copy link
Copy Markdown
Contributor

Typo in commit message, decription to description.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@pluris 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

pluris commented Aug 23, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor Author

@VoltrexKeyva Hi, Thank you. I fixed it.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
mscdex
mscdex reviewed Aug 23, 2023
View reviewed changes
Comment thread doc/api/string_decoder.md Outdated

@mscdex mscdex Aug 23, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

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.

Perhaps we can just shorten these descriptions down to simply:

The bytes to decode.

as duplicating the types is unnecessary

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
pluris reacted with rocket emoji
All reactions
  • 🚀 1 reaction

@pluris pluris Aug 23, 2023

Copy link
Copy Markdown
Contributor Author

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.

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
lpinca
lpinca approved these changes Aug 23, 2023
View reviewed changes
@deokjinkim

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?
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
pluris
doc: modify param description for end(),write() in StringDecoder
0eca1b7
@pluris
pluris force-pushed the fix/argument_string_decoder branch from ab493a8 to 0eca1b7 Compare August 24, 2023 13:42
@pluris

pluris commented Aug 24, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

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. 😓
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
deokjinkim
deokjinkim approved these changes Aug 24, 2023
View reviewed changes
@deokjinkim deokjinkim added author ready PRs with CI started, the required approvals, and no outstanding review comments. commit-queue PRs queued for automated landing through the Commit Queue. labels Aug 24, 2023
@nodejs-github-bot nodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Aug 24, 2023
@nodejs-github-bot
nodejs-github-bot merged commit a494ef6 into nodejs:main Aug 24, 2023
@nodejs-github-bot

nodejs-github-bot commented Aug 24, 2023

Copy link
Copy Markdown
Collaborator

Landed in a494ef6
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@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
Jungku Lee @UlisesGascon
doc: modify param description for end(),write() in StringDecoder
fefbdb9 
PR-URL: #49285
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Deokjin Kim <[email protected]>
@UlisesGascon UlisesGascon mentioned this pull request Sep 10, 2023
v20.7.0 proposal #49592
Merged
targos pushed a commit that referenced this pull request Nov 27, 2023
Jungku Lee @targos
doc: modify param description for end(),write() in StringDecoder
9ca85b5 
PR-URL: #49285
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Deokjin Kim <[email protected]>
@targos targos mentioned this pull request Nov 28, 2023
v18.19.0 release proposal #50953
Merged
sercher added a commit to sercher/graaljs that referenced this pull request Apr 25, 2024
@sercher
doc: modify param description for end(),write() in
8c37f76 
PR-URL: nodejs/node#49285
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Deokjin Kim <[email protected]>
sercher added a commit to sercher/graaljs that referenced this pull request Apr 25, 2024
@sercher
doc: modify param description for end(),write() in
51766a7 
PR-URL: nodejs/node#49285
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Deokjin Kim <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

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

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

author ready PRs with CI started, the required approvals, and no outstanding review comments. doc Issues and PRs related to Node.js documentation. 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.

Uh oh!

There was an error while loading. Please reload this page.

6 participants

@pluris @VoltrexKeyva @deokjinkim @nodejs-github-bot @mscdex @lpinca
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.