Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

docs: Fix description for buffer copy parameter#1387

Closed
alissonsv wants to merge 1 commit into
nodejs:masterfrom
alissonsv:patch-1
Closed

docs: Fix description for buffer copy parameter#1387
alissonsv wants to merge 1 commit into
nodejs:masterfrom
alissonsv:patch-1

Conversation

@alissonsv

Copy link
Copy Markdown

Incorrect description for the parameter

@Trott

Trott commented Jun 6, 2021

Copy link
Copy Markdown
Member

@nodejs/buffer

@addaleax addaleax left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good!

Unrelated question: Why are we recommending buffer.copy() instead of buffer.set()? I think we should stick to JS built-in methods where possible. (Ditto for buffer.slice().)

addaleax added a commit to addaleax/nodejs.dev that referenced this pull request Jun 6, 2021
- Remove wildly misleading text about how Buffers in Node.js are
  related to the concept of buffering
- Talk about UTF-8 instead of Unicode when UTF-8 is what the text
  is referring to and mention that it is dangerous to act as if
  bytes in a Buffer and characters are in 1:1 correspondence
- Recommend using standardized JS methods instead of
  Node.js-specific ones where possible

Refs: nodejs#1387 (review)
addaleax added a commit to addaleax/nodejs.dev that referenced this pull request Jun 6, 2021
- Remove wildly misleading text about how Buffers in Node.js are
  related to the concept of buffering
- Talk about UTF-8 instead of Unicode when UTF-8 is what the text
  is referring to and mention that it is dangerous to act as if
  bytes in a Buffer and characters are in 1:1 correspondence
- Recommend using standardized JS methods instead of
  Node.js-specific ones where possible

Refs: nodejs#1387 (review)
@alissonsv

Copy link
Copy Markdown
Author

Check #1388, she did a waaaay better job 😁

@alissonsv alissonsv closed this Jun 7, 2021
@alissonsv alissonsv deleted the patch-1 branch June 7, 2021 00:44
benhalverson pushed a commit that referenced this pull request Jun 8, 2021
- Remove wildly misleading text about how Buffers in Node.js are
  related to the concept of buffering
- Talk about UTF-8 instead of Unicode when UTF-8 is what the text
  is referring to and mention that it is dangerous to act as if
  bytes in a Buffer and characters are in 1:1 correspondence
- Recommend using standardized JS methods instead of
  Node.js-specific ones where possible

Refs: #1387 (review)
kevindavies8 added a commit to kevindavies8/nodejs.dev-for-full-stack-developer that referenced this pull request Aug 24, 2022
- Remove wildly misleading text about how Buffers in Node.js are
  related to the concept of buffering
- Talk about UTF-8 instead of Unicode when UTF-8 is what the text
  is referring to and mention that it is dangerous to act as if
  bytes in a Buffer and characters are in 1:1 correspondence
- Recommend using standardized JS methods instead of
  Node.js-specific ones where possible

Refs: nodejs/nodejs.dev#1387 (review)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants