Skip to content

doc: improvements to child_process, process docs - #5075

Closed
estliberitas wants to merge 1 commit into
nodejs:masterfrom
estliberitas:doc-fix-child_process-process
Closed

doc: improvements to child_process, process docs#5075
estliberitas wants to merge 1 commit into
nodejs:masterfrom
estliberitas:doc-fix-child_process-process

Conversation

@estliberitas

Copy link
Copy Markdown
Contributor

Sort links in lexical order. Add missing links.
Add disconnect event description in Process doc.
Fix typos.

Comment threaddoc/api/child_process.markdown Outdated

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Am I correct here? I did not found any mentioning of 'disconnected' event in source, so corrected this.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@trevnorris @nodejs/ctc

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.

Yes, a search of the codebase turns up emit('disconnect'), but not disconnected.

@thefourtheyethefourtheye added the doc Issues and PRs related to the documentations. label Feb 4, 2016
@estliberitasestliberitas mentioned this pull request Feb 4, 2016
@mscdexmscdex added child_process Issues and PRs related to the child_process subsystem. process Issues and PRs related to the process subsystem. labels Feb 4, 2016
@estliberitas

Copy link
Copy Markdown
ContributorAuthor

Seems I have to rebase, okay.

@estliberitas

Copy link
Copy Markdown
ContributorAuthor

Rebased.

Comment threaddoc/api/child_process.markdown Outdated

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.

double space

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sam-github

Copy link
Copy Markdown
Contributor

This is difficult to review, because of all the line re-wrapping, and the mixture of markup changes, and actual text content changes - I wish those two had been separate PRs.

Comment threaddoc/api/child_process.markdown Outdated

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.

Its basically impossible to tell during review without an eyeball straining line-by-line review whether you have just added markdown links to the above, or whether you also made some changes to the docs.

The markup changes can get rubber stamped if they look OK after converting to html, text changes need closer review.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I'll try to rebase and avoid word wrapping.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

@jasnell

Copy link
Copy Markdown
Member

LGTM

@jasnell

Copy link
Copy Markdown
Member

@nodejs/documentation ... can we get another review on this?

Comment threaddoc/api/child_process.markdown Outdated

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.

Please keep this reference to man pages.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@eljefedelrodeodeljefe Maybe no need in keeping links anymore thus #5073 landed?

@eljefedelrodeodeljefe

Copy link
Copy Markdown
Contributor

With nits concerning man page links and a little bit indecisive about: ChildProcess# -> child, but this probably has better readability.

LGTM

@eljefedelrodeodeljefe

Copy link
Copy Markdown
Contributor

@estliberitas that's right. Then just the exec(3) change. Thanks! LGTM

@estliberitas

Copy link
Copy Markdown
ContributorAuthor

@eljefedelrodeodeljefe done

Comment threaddoc/api/child_process.markdown Outdated

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.

Unrelated to this PR, but perhaps you can fix: turns out that .bat/.exe/.com are directly executable by spawn, but .cmd, .pl, .js etc. are not. This means that npm installed node scripts are not executable.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sam-github Mean, send PR to npm folks?)

@estliberitas

Copy link
Copy Markdown
ContributorAuthor

@sam-github Done.

@sam-github

Copy link
Copy Markdown
Contributor

looks good to me, but you'll have to rebase and resolve the conflicts.

@estliberitas

Copy link
Copy Markdown
ContributorAuthor

@sam-github done

@jasnell

Copy link
Copy Markdown
Member

@estliberitas ... very sorry but this is going to need another rebase.
@nodejs/documentation ... can we get a final round of reviews on this one please?

@silverwind

Copy link
Copy Markdown
Contributor

LGTM

@estliberitas

Copy link
Copy Markdown
ContributorAuthor

Ok will do in some hrs

Sort links in lexical order. Add missing links.
Add `disconnect` event description in Process doc.
Fix typos.
@estliberitas

Copy link
Copy Markdown
ContributorAuthor

Hi. Rebased.

jasnell pushed a commit that referenced this pull request Apr 22, 2016
Sort links in lexical order. Add missing links.
Add `disconnect` event description in Process doc.
Fix typos.
R-URL: #5075
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Robert Jefe Lindstädt <robert.lindstaedt@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
@jasnell

Copy link
Copy Markdown
Member

Landed in f85412d

@jasnelljasnell closed this Apr 22, 2016
joelostrowski pushed a commit to joelostrowski/node that referenced this pull request Apr 25, 2016
Sort links in lexical order. Add missing links.
Add `disconnect` event description in Process doc.
Fix typos.
R-URL: nodejs#5075
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Robert Jefe Lindstädt <robert.lindstaedt@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
jasnell pushed a commit that referenced this pull request Apr 26, 2016
Sort links in lexical order. Add missing links.
Add `disconnect` event description in Process doc.
Fix typos.
R-URL: #5075
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Robert Jefe Lindstädt <robert.lindstaedt@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
eljefedelrodeodeljefe pushed a commit that referenced this pull request May 24, 2016
Ref: #6911
Ref: #5075
PR-URL: #6952
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
Fishrock123 pushed a commit to Fishrock123/node that referenced this pull request May 30, 2016
Ref: nodejs#6911
Ref: nodejs#5075
PR-URL: nodejs#6952
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
@MylesBorins

Copy link
Copy Markdown
Contributor

dropping lts watch as this does not land cleanly... please feel free to open a new PR backporting this directly to v4.x-staging

rvagg pushed a commit that referenced this pull request Jun 2, 2016
Ref: #6911
Ref: #5075
PR-URL: #6952
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

child_processIssues and PRs related to the child_process subsystem.docIssues and PRs related to the documentations.processIssues and PRs related to the process subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants

@estliberitas@sam-github@jasnell@eljefedelrodeodeljefe@silverwind@MylesBorins@cjihrig@mscdex@thefourtheye