doc: note about custom inspect functions by thefourtheye · Pull Request #2142 · nodejs/node

thefourtheye · 2015-07-09T13:27:06Z

When an Object is printed in REPL, the actual representation can be
overriden by defining inspect method on the objects. This patch
includes a note about the same in the REPL documentation

targos · 2015-07-10T19:06:37Z

... defined aninspect function ...

Changed it now, thanks :-)

See: nodejs#1798 When an Object is printed in REPL, the actual representation can be overriden by defining `inspect` method on the objects. This patch includes a note about the same in the REPL documentation

thefourtheye · 2015-07-15T18:15:26Z

bump

Fishrock123 · 2015-07-16T23:01:32Z

Maybe remove depth?

Ah, copy/paste mistake. Thanks :-)

Fishrock123 · 2015-07-16T23:03:45Z

LGTM Otherwise.

thefourtheye · 2015-07-17T06:37:54Z

@Fishrock123 Addressed the comments. PTAL :-)

thefourtheye · 2015-07-22T19:05:19Z

Bump!

cjihrig · 2015-07-22T19:10:53Z

Maybe call this Customizing Object displays in the REPL

thefourtheye · 2015-07-22T19:14:51Z

@cjihrig Thanks for the review. I changed the text now. PTAL.

cjihrig · 2015-07-22T19:15:13Z

Period after function

I just used :. Should this be a .?

cjihrig · 2015-07-22T19:15:39Z

LGTM minus a few comments.

cjihrig · 2015-07-22T19:18:23Z

I think either a period or colon should be fine here. I originally said period because your sentence was coming to a finish, but you also have a following code block, so either should be fine.

Cool, thanks :-)

thefourtheye · 2015-07-22T19:20:56Z

@Fishrock123 Can you PTAL and give LGTM, so that I can land this?

EDIT: CC @targos

targos · 2015-07-22T19:26:59Z

The link should be relative. You can see how it's done in https://raw.githubusercontent.com/nodejs/io.js/master/doc/api/console.markdown

thefourtheye · 2015-07-22T19:35:44Z

Thanks for pointing it out @targos :-) PTAL now.

targos · 2015-07-22T19:43:22Z

LGTM

Fishrock123 · 2015-07-22T23:22:17Z

Should this be referred to as inspect()? I wish we had guidelines for that kind of thing... cc @nodejs/documentation

mscdex added doc Issues and PRs related to the documentations. repl Issues and PRs related to the REPL subsystem. labels Jul 9, 2015

targos reviewed Jul 10, 2015
View reviewed changes

doc: note about custom inspect functions
b08202a
See: nodejs#1798 When an Object is printed in REPL, the actual representation can be overriden by defining `inspect` method on the objects. This patch includes a note about the same in the REPL documentation

thefourtheye force-pushed the repl-doc-improvement-inspect branch from eec353d to b08202aCompare July 10, 2015 21:23

Fishrock123 reviewed Jul 16, 2015
View reviewed changes

Addressing review comments
95e47e8

cjihrig reviewed Jul 22, 2015
View reviewed changes

Comment threaddoc/api/repl.markdown Outdated
cjihrigJul 22, 2015
Copy link
Copy Markdown
Contributor
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe call this Customizing Object displays in the REPL

Incorporating cjihrig's comments
a631a66

cjihrig reviewed Jul 22, 2015
View reviewed changes

fix
19a80c2

cjihrig reviewed Jul 22, 2015
View reviewed changes

targos reviewed Jul 22, 2015
View reviewed changes

Fixing links
b2e6394

indutny force-pushed the master branch from bffb204 to eb35968Compare July 22, 2015 21:21

Fishrock123 reviewed Jul 22, 2015
View reviewed changes

Uh oh!

Uh oh!

Conversation

thefourtheye commented Jul 9, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thefourtheye commented Jul 15, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Fishrock123 commented Jul 16, 2015

Uh oh!

thefourtheye commented Jul 17, 2015

Uh oh!

thefourtheye commented Jul 22, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thefourtheye commented Jul 22, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cjihrig commented Jul 22, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thefourtheye commented Jul 22, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thefourtheye commented Jul 22, 2015

Uh oh!

targos commented Jul 22, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants