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: replace "above" and "below" where appropriate #4499

Closed
wants to merge 2 commits into from
Closed

doc: replace "above" and "below" where appropriate #4499

wants to merge 2 commits into from

Conversation

richardsun29
Copy link
Contributor

Sometimes, the docs reference relevant text using "above" and "below". Some of these references became incorrect after the documentation was resorted (#3662).

@JungMinu JungMinu added the doc Issues and PRs related to the documentations. label Dec 31, 2015
@cjihrig
Copy link
Contributor

cjihrig commented Dec 31, 2015

Maybe it would be better to eliminate this language completely where possible. It would prevent this type of issue from coming up again. Plus, we can just link to whatever is being referenced.

@mscdex
Copy link
Contributor

mscdex commented Dec 31, 2015

+1 for replacing the relative references with links or something equally better.

@richardsun29
Copy link
Contributor Author

I can try to do that, might take some time though.

@jasnell
Copy link
Member

jasnell commented Jan 8, 2016

LGTM

@@ -34,7 +34,7 @@ the event loop until the spawned process either exits of is terminated.

For convenience, the `child_process` module provides a handful of synchronous
and asynchronous alternatives to `child_process.spawn()` and
`child_process.spawnSync()`, each of which are documented fully [below][].
`child_process.spawnSync()`, each of which are documented fully [here][].
Copy link
Contributor

Choose a reason for hiding this comment

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

This doesn't entirely make sense. This links to the asynchronous process creation section. spawnSync() and company aren't documented there.

@cjihrig
Copy link
Contributor

cjihrig commented Jan 8, 2016

@richardsun29 Thanks for working on this. One thing - GitHub doesn't send a notification when you push a new commit. Can you comment on the PR once you've addressed nits.

Only changes references that use the words "above" or "below"
@richardsun29
Copy link
Contributor Author

Ah okay, didn't know about that :). I fixed @cjihrig's suggestions

@jasnell
Copy link
Member

jasnell commented Jan 11, 2016

Still LGTM

@cjihrig
Copy link
Contributor

cjihrig commented Jan 11, 2016

Landed in a2e77ce. Thanks!

@cjihrig cjihrig closed this Jan 11, 2016
cjihrig pushed a commit that referenced this pull request Jan 11, 2016
The docs were recently refactored, and some "above" and "below"
references were no longer accurate. This commit removes many
such references, and replaces others with links.

PR-URL: #4499
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
MylesBorins pushed a commit that referenced this pull request Jan 11, 2016
The docs were recently refactored, and some "above" and "below"
references were no longer accurate. This commit removes many
such references, and replaces others with links.

PR-URL: #4499
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@MylesBorins MylesBorins mentioned this pull request Jan 11, 2016
MylesBorins pushed a commit that referenced this pull request Jan 12, 2016
The docs were recently refactored, and some "above" and "below"
references were no longer accurate. This commit removes many
such references, and replaces others with links.

PR-URL: #4499
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@MylesBorins
Copy link
Contributor

This will likely have to be manually ported to LTS. We should likely wait for @jasnell's docfix commits to be all backported

@rvagg
Copy link
Member

rvagg commented Jan 18, 2016

Looks like this is your first commit in to core @richardsun29, thanks so much for taking the time and welcome on board! I hope we can help you find other places to contribute, docs are a great place to start.

MylesBorins pushed a commit that referenced this pull request Feb 22, 2016
The docs were recently refactored, and some "above" and "below"
references were no longer accurate. This commit removes many
such references, and replaces others with links.

PR-URL: #4499
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
MylesBorins pushed a commit that referenced this pull request Feb 22, 2016
The docs were recently refactored, and some "above" and "below"
references were no longer accurate. This commit removes many
such references, and replaces others with links.

PR-URL: #4499
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
MylesBorins pushed a commit that referenced this pull request Mar 2, 2016
The docs were recently refactored, and some "above" and "below"
references were no longer accurate. This commit removes many
such references, and replaces others with links.

PR-URL: #4499
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
scovetta pushed a commit to scovetta/node that referenced this pull request Apr 2, 2016
The docs were recently refactored, and some "above" and "below"
references were no longer accurate. This commit removes many
such references, and replaces others with links.

PR-URL: nodejs#4499
Reviewed-By: Colin Ihrig <[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
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants