doc: fix some nits in hardcoded manpage links #20854
Closed
Conversation
This file contains 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
|
Node.js Collaborators, please, add 👍 here if you approve fast-tracking. |
This comment has been minimized.
This comment has been minimized.
vsemozhetbyt
added
the
fast-track
addaleax
approved these changes
May 20, 2018
doc/api/errors.md
Outdated
| @@ -500,7 +500,8 @@ of a string, it is the same as `error.code`. | |||
|
|
|||
| * {string} | |||
|
|
|||
| The `error.syscall` property is a string describing the [syscall][] that failed. | |||
| The `error.syscall` property is a string describing the [`syscall(2)`][] that | |||
| failed. | |||
There was a problem hiding this comment.
This should link to http://man7.org/linux/man-pages/man2/syscalls.2.html rather than http://man7.org/linux/man-pages/man2/syscall.2.html – syscall itself is a specific function that is not really relevant to the concept of syscalls in general :)
There was a problem hiding this comment.
(i.e. we shouldn’t change the link text here either – we’re not talking about a code thing/identifier syscall)
There was a problem hiding this comment.
Amended. Please, check if it is correct now.
After #20785, we wrap autogenerated manpage links in code elements. This PR unify some hardcoded manpage links with autogenerated ones: it adds backticks, parentheses, section numbers, and updates URLs. Also, some typos are fixes in passing (missing periods, reference sorting).
BridgeAR
approved these changes
May 20, 2018
BridgeAR
added
the
author ready
|
Landed in a14a0fa |
vsemozhetbyt
added a commit
that referenced
this pull request
May 20, 2018
After #20785, we wrap autogenerated manpage links in code elements. This PR unify some hardcoded manpage links with autogenerated ones: it adds backticks, parentheses, section numbers, and updates URLs. Also, some typos are fixes in passing (missing periods, reference sorting). PR-URL: #20854 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
MylesBorins
pushed a commit
that referenced
this pull request
May 22, 2018
After #20785, we wrap autogenerated manpage links in code elements. This PR unify some hardcoded manpage links with autogenerated ones: it adds backticks, parentheses, section numbers, and updates URLs. Also, some typos are fixes in passing (missing periods, reference sorting). PR-URL: #20854 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
Merged
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAfter #20785, we wrap autogenerated manpage links in code elements. This PR unify some hardcoded manpage links with autogenerated ones: it adds backticks, parentheses, section numbers, and updates URLs.
Also, some typos are fixes in passing (missing periods, reference sorting).