Skip to content

Commit

Permalink
doc: remove "note that" from buffer.md
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Trott authored and targos committed Jul 2, 2019
1 parent 658c758 commit 9ca7c86
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions doc/api/buffer.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ console.log(buf2);
// Prints: <Buffer 88 13 70 17>
```

Note that when creating a `Buffer` using a [`TypedArray`][]'s `.buffer`, it is
When creating a `Buffer` using a [`TypedArray`][]'s `.buffer`, it is
possible to use only a portion of the underlying [`ArrayBuffer`][] by passing in
`byteOffset` and `length` parameters.

Expand Down Expand Up @@ -597,7 +597,7 @@ console.log(buf);

A `TypeError` will be thrown if `size` is not a number.

Note that the `Buffer` module pre-allocates an internal `Buffer` instance of
The `Buffer` module pre-allocates an internal `Buffer` instance of
size [`Buffer.poolSize`][] that is used as a pool for the fast allocation of new
`Buffer` instances created using [`Buffer.allocUnsafe()`][] and the deprecated
`new Buffer(size)` constructor only when `size` is less than or equal to
Expand Down Expand Up @@ -1501,7 +1501,7 @@ added: v0.1.90

* {integer}

Returns the amount of memory allocated for `buf` in bytes. Note that this
Returns the amount of memory allocated for `buf` in bytes. This
does not necessarily reflect the amount of "usable" data within `buf`.

```js
Expand Down Expand Up @@ -2087,7 +2087,7 @@ buf2.swap64();
// Throws ERR_INVALID_BUFFER_SIZE.
```

Note that JavaScript cannot encode 64-bit integers. This method is intended
JavaScript cannot encode 64-bit integers. This method is intended
for working with 64-bit floats.

### buf.toJSON()
Expand Down Expand Up @@ -2623,7 +2623,7 @@ Returns the maximum number of bytes that will be returned when
`buf.inspect()` is called. This can be overridden by user modules. See
[`util.inspect()`][] for more details on `buf.inspect()` behavior.

Note that this is a property on the `buffer` module returned by
This is a property on the `buffer` module returned by
`require('buffer')`, not on the `Buffer` global or a `Buffer` instance.

## buffer.kMaxLength
Expand All @@ -2635,7 +2635,7 @@ added: v3.0.0

An alias for [`buffer.constants.MAX_LENGTH`][].

Note that this is a property on the `buffer` module returned by
This is a property on the `buffer` module returned by
`require('buffer')`, not on the `Buffer` global or a `Buffer` instance.

## buffer.transcode(source, fromEnc, toEnc)
Expand Down Expand Up @@ -2675,7 +2675,7 @@ console.log(newBuf.toString('ascii'));
Because the Euro (``) sign is not representable in US-ASCII, it is replaced
with `?` in the transcoded `Buffer`.

Note that this is a property on the `buffer` module returned by
This is a property on the `buffer` module returned by
`require('buffer')`, not on the `Buffer` global or a `Buffer` instance.

## Class: SlowBuffer
Expand Down Expand Up @@ -2753,7 +2753,7 @@ console.log(buf);
added: v8.2.0
-->

Note that `buffer.constants` is a property on the `buffer` module returned by
`buffer.constants` is a property on the `buffer` module returned by
`require('buffer')`, not on the `Buffer` global or a `Buffer` instance.

### buffer.constants.MAX_LENGTH
Expand Down

0 comments on commit 9ca7c86

Please sign in to comment.