Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
wants to merge 1 commit into from

Conversation

jmm
Copy link
Contributor

@jmm jmm commented Nov 10, 2015

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 mscdex added doc Issues and PRs related to the documentations. console Issues and PRs related to the console subsystem. labels Nov 10, 2015
@jasnell
Copy link
Member

jasnell commented Nov 12, 2015

LGTM

@targos
Copy link
Member

targos commented Nov 12, 2015

LGTM

@jasnell
Copy link
Member

jasnell commented Nov 13, 2015

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

@jmm
Copy link
Contributor Author

jmm commented Nov 13, 2015

@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
Copy link
Member

jasnell commented Nov 13, 2015

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
PR-URL: #3749
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@jasnell
Copy link
Member

jasnell commented Nov 13, 2015

Landed in b445938

@jasnell jasnell closed this Nov 13, 2015
@jmm
Copy link
Contributor Author

jmm commented Nov 13, 2015

@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
Copy link
Member

jasnell commented Nov 13, 2015

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

@jmm
Copy link
Contributor Author

jmm commented Nov 16, 2015

@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
Copy link
Member

jasnell commented Nov 16, 2015

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
PR-URL: #3749
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@MylesBorins
Copy link
Contributor

landed in v4.x-staging in 877d86d

Fishrock123 pushed a commit that referenced this pull request Nov 17, 2015
PR-URL: #3749
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@jmm
Copy link
Contributor Author

jmm commented Nov 17, 2015

@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
PR-URL: #3749
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@jasnell jasnell mentioned this pull request Dec 17, 2015
jasnell pushed a commit that referenced this pull request Dec 17, 2015
PR-URL: #3749
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: James M Snell <[email protected]>
jasnell pushed a commit that referenced this pull request Dec 23, 2015
PR-URL: #3749
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
console Issues and PRs related to the console subsystem. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants