FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: add link to [customizing util.inspect colors]. by jmm · Pull Request #3749 · nodejs/node · GitHub

/ node Public

doc: add link to [customizing util.inspect colors]. - #3749

Closed
jmm wants to merge 1 commit into
nodejs:masterfrom
jmm:console-colors-docs-v5-02
ConversationCommits (1)ChecksFiles changed
Closed

doc: add link to [customizing util.inspect colors].#3749
jmm wants to merge 1 commit into
nodejs:masterfrom
jmm:console-colors-docs-v5-02

Conversation

jmm commented Nov 10, 2015

Copy link
Copy Markdown
Contributor

Previously this said "see below" to nowhere.

Applicable to 4.x and 5.x.

  1. Another option would be to link to the util.inspect() documentation for all of the options (showHidden|depth|colors) instead of duplicating them (that'd be my preference, unless the build system can accomodate that content being located in one place and inserted in both places in the output).

  2. The task for building the docs depends on building Node? That is prohibitively slow for making docs changes. (I'm doing it where I already have a functioning Node installation.) I had to hack the build scripts to get around that to be able to make these changes, and I wouldn't attempt this again without being able to build them using the existing Node install. It's possible I've misunderstood or done something wrong -- I just followed the instructions from the README: $ make doc.

  3. What does CONTRIBUTING.md mean?:

    The rules for the master branch are less strict;

    Less strict than what?

mscdex added doc Issues and PRs related to the documentations. console Issues and PRs related to the console subsystem. labels Nov 10, 2015
jmm mentioned this pull request Nov 10, 2015
Closed

jasnell commented Nov 12, 2015

Copy link
Copy Markdown
Member

LGTM

targos commented Nov 12, 2015

Copy link
Copy Markdown
Member

LGTM

jasnell commented Nov 13, 2015

Copy link
Copy Markdown
Member

@jmm ... can you please rebase and update this?

jmm force-pushed the console-colors-docs-v5-02 branch from db4b07f to 923413c Compare November 13, 2015 22:34

jmm commented Nov 13, 2015

Copy link
Copy Markdown
Contributor Author

@jasnell Sure, done. Is there any special logic to where the link references were moved to (as opposed to the bottom)? (FWIW I generally prefer to just inline links.)

jasnell commented Nov 13, 2015

Copy link
Copy Markdown
Member

I don't believe so. The docs were just restructured to use an alphabetical sort. This LGTM!

jasnell pushed a commit that referenced this pull request Nov 13, 2015
doc: add link to [customizing util.inspect colors].
b445938 
PR-URL: #3749
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

jasnell commented Nov 13, 2015

Copy link
Copy Markdown
Member

Landed in b445938

jasnell closed this Nov 13, 2015

jmm commented Nov 13, 2015

Copy link
Copy Markdown
Contributor Author

@jasnell Thanks. Would there be any interest in enhancing the build scripts so that docs can be built with an existing Node installation (re: # 2 above)?

jasnell commented Nov 13, 2015

Copy link
Copy Markdown
Member

@jmm likely yes. You may want to engage the @nodejs/documentation team /cc @chrisdickinson

jmm commented Nov 16, 2015

Copy link
Copy Markdown
Contributor Author

@jasnell Ok, thanks. Is there something for me to do to follow up on that, or just wait and see if they comment here?

jasnell commented Nov 16, 2015

Copy link
Copy Markdown
Member

Well, if the changes in #2 that you're suggesting are not in this PR, the best thing would be to either update this PR or create a new one with those changes and cc the documentation team.

MylesBorins pushed a commit that referenced this pull request Nov 17, 2015
doc: add link to [customizing util.inspect colors].
877d86d 
PR-URL: #3749
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

MylesBorins commented Nov 17, 2015

Copy link
Copy Markdown
Contributor

landed in v4.x-staging in 877d86d

rvagg mentioned this pull request Nov 17, 2015
Closed
Fishrock123 pushed a commit that referenced this pull request Nov 17, 2015
doc: add link to [customizing util.inspect colors].
96f53c6 
PR-URL: #3749
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
jmm mentioned this pull request Nov 17, 2015
Closed

jmm commented Nov 17, 2015

Copy link
Copy Markdown
Contributor Author

@jasnell Thanks. Yeah, this PR made no attempt to change the build process, just markdown. I wanted to at least get some kind of thumbs up for the general idea / see if someone who's better at Make was interested in doing it. I took a stab at it: #3888. I tried cc'ing @nodejs/documentation, but it doesn't appear I can. I'm also not sure where I could find out who's on the team.

rvagg pushed a commit that referenced this pull request Dec 4, 2015
doc: add link to [customizing util.inspect colors].
d28c35a 
PR-URL: #3749
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
jasnell mentioned this pull request Dec 17, 2015
Closed
jasnell pushed a commit that referenced this pull request Dec 17, 2015
doc: add link to [customizing util.inspect colors].
29f26b8 
PR-URL: #3749
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
jasnell pushed a commit that referenced this pull request Dec 23, 2015
doc: add link to [customizing util.inspect colors].
52542b5 
PR-URL: #3749
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
This file contains hidden or 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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

console Issues and PRs related to the console subsystem. doc Issues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

Back | FazBrowse Home | New Git URL