doc: replace "above" and "below" where appropriate #4499
Conversation
|
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. |
|
+1 for replacing the relative references with links or something equally better. |
|
I can try to do that, might take some time though. |
|
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][]. | |||
There was a problem hiding this comment.
This doesn't entirely make sense. This links to the asynchronous process creation section. spawnSync() and company aren't documented there.
|
@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"
|
Ah okay, didn't know about that :). I fixed @cjihrig's suggestions |
|
Still LGTM |
|
Landed in a2e77ce. Thanks! |
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>
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>
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 will likely have to be manually ported to LTS. We should likely wait for @jasnell's docfix commits to be all backported |
|
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. |
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>
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>
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>
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 <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Sometimes, the docs reference relevant text using "above" and "below". Some of these references became incorrect after the documentation was resorted (#3662).