Skip to content

Commit 6d3c6b8

Browse files
authored
[Squash] reword a bit
1 parent db48bb3 commit 6d3c6b8

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

doc/api/util.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -250,10 +250,10 @@ without any formatting.
250250
util.format('%% %s'); // '%% %s'
251251
```
252252

253-
It is immportant to note that `util.format()` is a synchronous method that is
254-
intended strictly as a debugging tool that has not been performance optimized.
255-
Using `util.format()` in production code is not recommended because of the
256-
potential performance bottlenecks it can introduce.
253+
Please note that `util.format()` is a synchronous method that is mainly
254+
intended as a debugging tool. Some input values can have a significant
255+
performance overhead that can block the event loop. Use this function
256+
with care and never in a hot code path.
257257

258258
## util.inherits(constructor, superConstructor)
259259
<!-- YAML
@@ -401,10 +401,10 @@ Values may supply their own custom `inspect(depth, opts)` functions, when
401401
called these receive the current `depth` in the recursive inspection, as well as
402402
the options object passed to `util.inspect()`.
403403

404-
It is immportant to note that `util.inspect()` is a synchronous method that is
405-
intended strictly as a debugging tool that has not been performance optimized.
406-
Using `util.inspect()` in production code is not recommended because of the
407-
potential performance bottlenecks it can introduce.
404+
Please note that `util.inspect()` is a synchronous method that is mainly
405+
intended as a debugging tool. Some input values can have a significant
406+
performance overhead that can block the event loop. Use this function
407+
with care and never in a hot code path.
408408

409409
### Customizing `util.inspect` colors
410410

0 commit comments

Comments
 (0)