doc: shorten character encoding introduction #19648
Closed
Conversation
This file contains 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
nodejs-github-bot
added
buffer
gireeshpunathil
previously requested changes
Mar 28, 2018
There was a problem hiding this comment.
sorry, but -1 for this change as such, it takes out information without providing alternatives IMO.
suggestions:
-
reword the removed text by addressing the problems you spotted, or stating the common use case for the character encodings.
-
the example provided does not fully cover the current wording (
converting between string and buffer) instead only buffer to string. An example ofBuffer.from(string[, encoding])will make it complete.
|
I feel I would agree with @gireeshpunathil. |
The first line of the example code is a |
|
sure, that looks great, @Trott ! |
jasnell
approved these changes
Mar 28, 2018
Keep the introduction for Buffers and character encodings short and to
the point. The current introduction doesn't provide much in the way of
useful additional information, but it is a bit confusing in its wording.
("such as" seems like it ought to refer to "encoded characters" but it
actually refers to character encodings, which are not mentioned in the
sentence. It may be arguable as to whether "hex-encoded" is in fact a
character encoding, whether it should be stylized as "Hex-encoded" or
not, and whether it should be spelled out as "Hexadecimal-encoded". None
of that information is particularly useful to the end user at this point
in the text. Omitting it simplifies and improves the documentation.)
Additionally, the section is now wrapped to 80 characters.
|
@gireeshpunathil @TimothyGu I've tried to address the comments. PTAL. Thanks. |
gireeshpunathil
dismissed
their stale review
thanks @Trott, changes looks good to me now.
gireeshpunathil
approved these changes
Mar 29, 2018
Trott
added
the
author ready
TimothyGu
approved these changes
Mar 29, 2018
|
|
||
| console.log(Buffer.from('fhqwhgads', 'ascii')); | ||
| // Prints: <Buffer 66 68 71 77 68 67 61 64 73> | ||
| console.log(Buffer.from('fhqwhgads', 'ucs2')); |
There was a problem hiding this comment.
I'd very slightly prefer the name 'utf16le', which is I think better known (and more accurate) than 'ucs2'.
|
Lite CI rerun: https://ci.nodejs.org/job/node-test-pull-request-lite/358/ |
Trott
added a commit
to Trott/io.js
that referenced
this pull request
Mar 30, 2018
Keep the introduction for Buffers and character encodings short and to
the point. The current introduction doesn't provide much in the way of
useful additional information, but it is a bit confusing in its wording.
("such as" seems like it ought to refer to "encoded characters" but it
actually refers to character encodings, which are not mentioned in the
sentence. It may be arguable as to whether "hex-encoded" is in fact a
character encoding, whether it should be stylized as "Hex-encoded" or
not, and whether it should be spelled out as "Hexadecimal-encoded". None
of that information is particularly useful to the end user at this point
in the text. Omitting it simplifies and improves the documentation.)
Additionally, the section is now wrapped to 80 characters.
PR-URL: nodejs#19648
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Gireesh Punathil <[email protected]>
Reviewed-By: Tiancheng "Timothy" Gu <[email protected]>
|
Landed in 6c5144f |
Trott
added a commit
to Trott/io.js
that referenced
this pull request
Mar 30, 2018
Favor 'utf16le' over its alias 'ucs2' in `buffer.md`. Ref: nodejs#19648 (comment)
2 tasks
Trott
added a commit
to Trott/io.js
that referenced
this pull request
Apr 2, 2018
Favor 'utf16le' over its alias 'ucs2' in `buffer.md`. Ref: nodejs#19648 (comment) PR-URL: nodejs#19688 Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]>
targos
pushed a commit
that referenced
this pull request
Apr 2, 2018
Keep the introduction for Buffers and character encodings short and to
the point. The current introduction doesn't provide much in the way of
useful additional information, but it is a bit confusing in its wording.
("such as" seems like it ought to refer to "encoded characters" but it
actually refers to character encodings, which are not mentioned in the
sentence. It may be arguable as to whether "hex-encoded" is in fact a
character encoding, whether it should be stylized as "Hex-encoded" or
not, and whether it should be spelled out as "Hexadecimal-encoded". None
of that information is particularly useful to the end user at this point
in the text. Omitting it simplifies and improves the documentation.)
Additionally, the section is now wrapped to 80 characters.
PR-URL: #19648
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Gireesh Punathil <[email protected]>
Reviewed-By: Tiancheng "Timothy" Gu <[email protected]>
targos
pushed a commit
that referenced
this pull request
Apr 2, 2018
Favor 'utf16le' over its alias 'ucs2' in `buffer.md`. Ref: #19648 (comment) PR-URL: #19688 Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Keep the introduction for Buffers and character encodings short and to
the point. The current introduction doesn't provide much in the way of
useful additional information, but it is a bit confusing in its wording.
("such as" seems like it ought to refer to "encoded characters" but it
actually refers to character encodings, which are not mentioned in the
sentence. It may be arguable as to whether "hex-encoded" is in fact a
character encoding, whether it should be stylized as "Hex-encoded" or
not, and whether it should be spelled out as "Hexadecimal-encoded". None
of that information is particularly useful to the end user at this point
in the text. Omitting it simplifies and improves the documentation.)
Additionally, the section is now wrapped to 80 characters.
Checklist