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

doc: replace "above" and "below" where appropriate by richardsun29 · Pull Request #4499 · nodejs/node · GitHub

/ node Public

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

Closed
richardsun29 wants to merge 2 commits into
nodejs:masterfrom
richardsun29:docs
ConversationCommits (2)ChecksFiles changed
Closed

doc: replace "above" and "below" where appropriate#4499
richardsun29 wants to merge 2 commits into
nodejs:masterfrom
richardsun29:docs

Conversation

richardsun29 commented Dec 31, 2015

Copy link
Copy Markdown
Contributor

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

JungMinu added the doc Issues and PRs related to the documentations. label Dec 31, 2015

cjihrig commented Dec 31, 2015

Copy link
Copy Markdown
Contributor

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 commented Dec 31, 2015

Copy link
Copy Markdown
Contributor

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

richardsun29 commented Jan 4, 2016

Copy link
Copy Markdown
Contributor Author

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

jasnell commented Jan 8, 2016

Copy link
Copy Markdown
Member

LGTM

cjihrig reviewed Jan 8, 2016
View reviewed changes
Comment thread doc/api/child_process.markdown Outdated

cjihrig Jan 8, 2016

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

cjihrig commented Jan 8, 2016

Copy link
Copy Markdown
Contributor

@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.

Replace relative references with links
a112106 
Only changes references that use the words "above" or "below"
doc: more descriptive link targets
3186846

richardsun29 commented Jan 9, 2016

Copy link
Copy Markdown
Contributor Author

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

jasnell commented Jan 11, 2016

Copy link
Copy Markdown
Member

Still LGTM

cjihrig commented Jan 11, 2016

Copy link
Copy Markdown
Contributor

Landed in a2e77ce. Thanks!

cjihrig closed this Jan 11, 2016
cjihrig pushed a commit that referenced this pull request Jan 11, 2016
doc: remove "above" and "below" references
a2e77ce 
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 <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Jan 11, 2016
doc: remove "above" and "below" references
8edb41d 
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 <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins mentioned this pull request Jan 11, 2016
Merged
MylesBorins pushed a commit that referenced this pull request Jan 12, 2016
doc: remove "above" and "below" references
102fb7d 
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 <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

MylesBorins commented Jan 13, 2016

Copy link
Copy Markdown
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 commented Jan 18, 2016

Copy link
Copy Markdown
Member

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
doc: remove "above" and "below" references
7107822 
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 <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Feb 22, 2016
doc: remove "above" and "below" references
de9ad5b 
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 <cjihrig@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

doc Issues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

Back | FazBrowse Home | New Git URL