Skip to content

Commit

Permalink
doc: clarify util.inspect usage intent
Browse files Browse the repository at this point in the history
  • Loading branch information
devsnek committed Dec 8, 2017
1 parent 762ed33 commit dd79402
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions doc/api/util.md
Original file line number Diff line number Diff line change
Expand Up @@ -348,8 +348,9 @@ changes:
line. Defaults to 60 for legacy compatibility.

The `util.inspect()` method returns a string representation of `object` that is
primarily useful for debugging. Additional `options` may be passed that alter
certain aspects of the formatted string.
intended for debugging. The output of `util.inspect` may change at any time
and should not be depended upon programmatically. Additional `options` may be
passed that alter certain aspects of the formatted string.
`util.inspect()` will use the constructor's name and/or `@@toStringTag` to make an
identifiable tag for an inspected value.

Expand Down

0 comments on commit dd79402

Please sign in to comment.