Skip to content

Commit c3c86b6

Browse files
Trotttargos
authored andcommitted
doc: remove "note that" from util.md
Refs: nodejs/remark-preset-lint-node#16 PR-URL: #28329 Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
1 parent 6d94620 commit c3c86b6

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

doc/api/util.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -276,10 +276,9 @@ util.format('%% %s');
276276
// Returns: '%% %s'
277277
```
278278

279-
Please note that `util.format()` is a synchronous method that is mainly
280-
intended as a debugging tool. Some input values can have a significant
281-
performance overhead that can block the event loop. Use this function
282-
with care and never in a hot code path.
279+
`util.format()` is a synchronous method that is intended as a debugging tool.
280+
Some input values can have a significant performance overhead that can block the
281+
event loop. Use this function with care and never in a hot code path.
283282

284283
## util.formatWithOptions(inspectOptions, format[, ...args])
285284
<!-- YAML
@@ -477,7 +476,7 @@ changes:
477476
to be displayed on a new line. It will also add new lines to text that is
478477
longer than `breakLength`. If set to a number, the most `n` inner elements
479478
are united on a single line as long as all properties fit into
480-
`breakLength`. Short array elements are also grouped together. Note that no
479+
`breakLength`. Short array elements are also grouped together. No
481480
text will be reduced below 16 characters, no matter the `breakLength` size.
482481
For more information, see the example below. **Default:** `3`.
483482
* `sorted` {boolean|Function} If set to `true` or a function, all properties
@@ -1138,7 +1137,7 @@ added: v10.0.0
11381137
* Returns: {boolean}
11391138

11401139
Returns `true` if the value is an [async function][].
1141-
Note that this only reports back what the JavaScript engine is seeing;
1140+
This only reports back what the JavaScript engine is seeing;
11421141
in particular, the return value may not match the original source code if
11431142
a transpilation tool was used.
11441143

@@ -1301,7 +1300,7 @@ added: v10.0.0
13011300
* Returns: {boolean}
13021301

13031302
Returns `true` if the value is a generator function.
1304-
Note that this only reports back what the JavaScript engine is seeing;
1303+
This only reports back what the JavaScript engine is seeing;
13051304
in particular, the return value may not match the original source code if
13061305
a transpilation tool was used.
13071306

@@ -1320,7 +1319,7 @@ added: v10.0.0
13201319

13211320
Returns `true` if the value is a generator object as returned from a
13221321
built-in generator function.
1323-
Note that this only reports back what the JavaScript engine is seeing;
1322+
This only reports back what the JavaScript engine is seeing;
13241323
in particular, the return value may not match the original source code if
13251324
a transpilation tool was used.
13261325

@@ -1858,7 +1857,7 @@ util.isError({ name: 'Error', message: 'an error occurred' });
18581857
// Returns: false
18591858
```
18601859

1861-
Note that this method relies on `Object.prototype.toString()` behavior. It is
1860+
This method relies on `Object.prototype.toString()` behavior. It is
18621861
possible to obtain an incorrect result when the `object` argument manipulates
18631862
`@@toStringTag`.
18641863

0 commit comments

Comments
 (0)