summaryrefslogtreecommitdiff
path: root/doc/api/buffer.md
diff options
context:
space:
mode:
authorJames M Snell <jasnell@gmail.com>2018-02-05 21:55:16 -0800
committerAnatoli Papirovski <apapirovski@mac.com>2018-02-08 11:57:14 -0500
commitd3569b623ccd593c9ef62fcaf0aba2711dc7fbfa (patch)
tree643d44f1eb33c9b822fea7742d2691355d295a4c /doc/api/buffer.md
parent809af1fe8a0a096be4f0a3020f8e60ee1c827cbc (diff)
downloadandroid-node-v8-d3569b623ccd593c9ef62fcaf0aba2711dc7fbfa.tar.gz
android-node-v8-d3569b623ccd593c9ef62fcaf0aba2711dc7fbfa.tar.bz2
android-node-v8-d3569b623ccd593c9ef62fcaf0aba2711dc7fbfa.zip
doc: remove **Note:** tags
Remove the various **Note:** prefixes throughout the docs. PR-URL: https://github.com/nodejs/node/pull/18592 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Diffstat (limited to 'doc/api/buffer.md')
-rw-r--r--doc/api/buffer.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/api/buffer.md b/doc/api/buffer.md
index 5e72e3bd96..ec2c409ba5 100644
--- a/doc/api/buffer.md
+++ b/doc/api/buffer.md
@@ -195,10 +195,10 @@ The character encodings currently supported by Node.js include:
* `'hex'` - Encode each byte as two hexadecimal characters.
-*Note*: Today's browsers follow the [WHATWG Encoding Standard][] which aliases
-both 'latin1' and ISO-8859-1 to win-1252. This means that while doing something
-like `http.get()`, if the returned charset is one of those listed in the WHATWG
-specification it is possible that the server actually returned
+Modern Web browsers follow the [WHATWG Encoding Standard][] which aliases
+both `'latin1'` and `'ISO-8859-1'` to `'win-1252'`. This means that while doing
+something like `http.get()`, if the returned charset is one of those listed in
+the WHATWG specification it is possible that the server actually returned
win-1252-encoded data, and using `'latin1'` encoding may incorrectly decode the
characters.
@@ -702,9 +702,9 @@ Returns the actual byte length of a string. This is not the same as
[`String.prototype.length`] since that returns the number of *characters* in
a string.
-*Note*: For `'base64'` and `'hex'`, this function assumes valid input. For
-strings that contain non-Base64/Hex-encoded data (e.g. whitespace), the return
-value might be greater than the length of a `Buffer` created from the string.
+For `'base64'` and `'hex'`, this function assumes valid input. For strings that
+contain non-Base64/Hex-encoded data (e.g. whitespace), the return value might be
+greater than the length of a `Buffer` created from the string.
Example:
@@ -1948,8 +1948,8 @@ offset and cropped by the `start` and `end` indices.
Specifying `end` greater than [`buf.length`] will return the same result as
that of `end` equal to [`buf.length`].
-*Note*: Modifying the new `Buffer` slice will modify the memory in the
-original `Buffer` because the allocated memory of the two objects overlap.
+Modifying the new `Buffer` slice will modify the memory in the original `Buffer`
+because the allocated memory of the two objects overlap.
Example: Create a `Buffer` with the ASCII alphabet, take a slice, and then modify
one byte from the original `Buffer`