doc: general improvements to util.md #6897
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jasnell
added
util
| show all array elements. Set to `0` or negative to show no array elements. | ||
|
|
||
| Example of inspecting all properties of the `util` object: | ||
| * `object` {any} Any JavsScript primitive or Object. |
|
|
||
| ### Custom `inspect()` function on Objects | ||
|
|
||
| <!-- type=misc --> | ||
|
|
||
| Objects also may define their own `inspect(depth)` function which `util.inspect()` | ||
| will invoke and use the result of when inspecting the object: | ||
| Objects also define their own `inspect(depth, opts)` function that |
There was a problem hiding this comment.
nit: I think the may was fine here.
There was a problem hiding this comment.
doh! was going to move the may before the also but missed it ...
|
@addaleax ... fixed! |
| @@ -130,6 +128,9 @@ _Note: usage of util.inherits() is discouraged. Please use the ES6 `class` and | |||
| `extends` keywords to get language level inheritance support. Also note that | |||
| the two styles are [semantically incompatible][]._ | |||
|
|
|||
| * `constructor` {Function} | |||
| * `superConstructor` {Function} | |||
|
|
|||
There was a problem hiding this comment.
Possibly don't have any efforts here, to further discourage it.
There was a problem hiding this comment.
Do you mean not to make edits here?
There was a problem hiding this comment.
Yeah, but I continued reading and you added those for the deprecated APIs as well. It would be more consistent then to have this <- change of mind. Thx.
|
LGTM, and big +1 for grouping the deprecated functions at the bottom! |
|
LGTM. Very good @jasnell. |
jasnell
added a commit
that referenced
this pull request
May 23, 2016
PR-URL: #6897 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
|
Landed in ef9778c |
Fishrock123
pushed a commit
that referenced
this pull request
May 23, 2016
PR-URL: #6897 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
rvagg
pushed a commit
that referenced
this pull request
Jun 2, 2016
PR-URL: #6897 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
Affected core subsystem(s)
doc (util)
Description of change
General improvements to util.md copy
@nodejs/documentation