doc: standardize rest parameters#8485
Closed
TimothyGu wants to merge 1 commit intonodejs:masterfrom
TimothyGu:std-rest-params
Closed
doc: standardize rest parameters#8485TimothyGu wants to merge 1 commit intonodejs:masterfrom TimothyGu:std-rest-params
TimothyGu wants to merge 1 commit intonodejs:masterfrom
TimothyGu:std-rest-params
Conversation
Member
|
Thanks, LGTM!
Hmm. We have been pretty liberal with changing these so far, and definitely thank you for taking care of the internal links that would otherwise have been broken… |
Contributor
|
LGTM. As long as the internal links in the docs are working, I think we're fine. As @addaleax said, we've changed these pretty freely in the past. We haven't started considering documentation link changes as semver major... YET. |
doc/api/util.md
Outdated
Member
There was a problem hiding this comment.
Capitalize the type so it will be properly linked.
Member
|
LGTM |
Member
|
LGTM |
Member
|
Landed in e1ddcb7, thanks! |
lpinca
pushed a commit
that referenced
this pull request
Sep 14, 2016
PR-URL: #8485 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Fishrock123
pushed a commit
that referenced
this pull request
Oct 11, 2016
PR-URL: #8485 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@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
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
Affected core subsystem(s)
doc
Description of change
Current, rest parameters in API documentation take a variety of inconsistent forms, many of which cause the JSON documentation generator to emit a warning such as the following:
This pull request adopts a consistent form of documenting rest parameters, that fits the ES2015 syntax and is digestible for the documentation generator.
One caveat is that this PR changes the anchors of numerous functions, which may break links on the Internet. I could manually add
<a id>to mitigate that, so let me know if that is preferred.