Commit 9ca7c86
doc: remove "note that" from buffer.md
Refs: nodejs/remark-preset-lint-node#16
PR-URL: #28329
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>1 parent 658c758 commit 9ca7c86
1 file changed
Lines changed: 8 additions & 8 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -250,7 +250,7 @@ console.log(buf2); | |||
| 250 | 250 | // Prints: <Buffer 88 13 70 17> | |
| 251 | 251 | ``` | |
| 252 | 252 | ||
| 253 | - Note that when creating a `Buffer` using a [`TypedArray`][]'s `.buffer`, it is | ||
| 253 | + When creating a `Buffer` using a [`TypedArray`][]'s `.buffer`, it is | ||
| 254 | 254 | possible to use only a portion of the underlying [`ArrayBuffer`][] by passing in | |
| 255 | 255 | `byteOffset` and `length` parameters. | |
| 256 | 256 | ||
@@ -597,7 +597,7 @@ console.log(buf); | |||
| 597 | 597 | ||
| 598 | 598 | A `TypeError` will be thrown if `size` is not a number. | |
| 599 | 599 | ||
| 600 | - Note that the `Buffer` module pre-allocates an internal `Buffer` instance of | ||
| 600 | + The `Buffer` module pre-allocates an internal `Buffer` instance of | ||
| 601 | 601 | size [`Buffer.poolSize`][] that is used as a pool for the fast allocation of new | |
| 602 | 602 | `Buffer` instances created using [`Buffer.allocUnsafe()`][] and the deprecated | |
| 603 | 603 | `new Buffer(size)` constructor only when `size` is less than or equal to | |
@@ -1501,7 +1501,7 @@ added: v0.1.90 | |||
| 1501 | 1501 | ||
| 1502 | 1502 | * {integer} | |
| 1503 | 1503 | ||
| 1504 | - Returns the amount of memory allocated for `buf` in bytes. Note that this | ||
| 1504 | + Returns the amount of memory allocated for `buf` in bytes. This | ||
| 1505 | 1505 | does not necessarily reflect the amount of "usable" data within `buf`. | |
| 1506 | 1506 | ||
| 1507 | 1507 | ```js | |
@@ -2087,7 +2087,7 @@ buf2.swap64(); | |||
| 2087 | 2087 | // Throws ERR_INVALID_BUFFER_SIZE. | |
| 2088 | 2088 | ``` | |
| 2089 | 2089 | ||
| 2090 | - Note that JavaScript cannot encode 64-bit integers. This method is intended | ||
| 2090 | + JavaScript cannot encode 64-bit integers. This method is intended | ||
| 2091 | 2091 | for working with 64-bit floats. | |
| 2092 | 2092 | ||
| 2093 | 2093 | ### buf.toJSON() | |
@@ -2623,7 +2623,7 @@ Returns the maximum number of bytes that will be returned when | |||
| 2623 | 2623 | `buf.inspect()` is called. This can be overridden by user modules. See | |
| 2624 | 2624 | [`util.inspect()`][] for more details on `buf.inspect()` behavior. | |
| 2625 | 2625 | ||
| 2626 | - Note that this is a property on the `buffer` module returned by | ||
| 2626 | + This is a property on the `buffer` module returned by | ||
| 2627 | 2627 | `require('buffer')`, not on the `Buffer` global or a `Buffer` instance. | |
| 2628 | 2628 | ||
| 2629 | 2629 | ## buffer.kMaxLength | |
@@ -2635,7 +2635,7 @@ added: v3.0.0 | |||
| 2635 | 2635 | ||
| 2636 | 2636 | An alias for [`buffer.constants.MAX_LENGTH`][]. | |
| 2637 | 2637 | ||
| 2638 | - Note that this is a property on the `buffer` module returned by | ||
| 2638 | + This is a property on the `buffer` module returned by | ||
| 2639 | 2639 | `require('buffer')`, not on the `Buffer` global or a `Buffer` instance. | |
| 2640 | 2640 | ||
| 2641 | 2641 | ## buffer.transcode(source, fromEnc, toEnc) | |
@@ -2675,7 +2675,7 @@ console.log(newBuf.toString('ascii')); | |||
| 2675 | 2675 | Because the Euro (`€`) sign is not representable in US-ASCII, it is replaced | |
| 2676 | 2676 | with `?` in the transcoded `Buffer`. | |
| 2677 | 2677 | ||
| 2678 | - Note that this is a property on the `buffer` module returned by | ||
| 2678 | + This is a property on the `buffer` module returned by | ||
| 2679 | 2679 | `require('buffer')`, not on the `Buffer` global or a `Buffer` instance. | |
| 2680 | 2680 | ||
| 2681 | 2681 | ## Class: SlowBuffer | |
@@ -2753,7 +2753,7 @@ console.log(buf); | |||
| 2753 | 2753 | added: v8.2.0 | |
| 2754 | 2754 | --> | |
| 2755 | 2755 | ||
| 2756 | - Note that `buffer.constants` is a property on the `buffer` module returned by | ||
| 2756 | + `buffer.constants` is a property on the `buffer` module returned by | ||
| 2757 | 2757 | `require('buffer')`, not on the `Buffer` global or a `Buffer` instance. | |
| 2758 | 2758 | ||
| 2759 | 2759 | ### buffer.constants.MAX_LENGTH | |
0 commit comments