-
Notifications
You must be signed in to change notification settings - Fork 29.8k
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: standardize rest parameters #8485
Conversation
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… |
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. |
<!-- YAML | ||
added: v0.3.0 | ||
deprecated: v0.11.3 | ||
--> | ||
|
||
> Stability: 0 - Deprecated: Use [`console.error()`][] instead. | ||
|
||
* `string` {string} The message to print to `stderr` | ||
* `...strings` {string} The message to print to `stderr` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Capitalize the type so it will be properly linked.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed.
LGTM |
LGTM |
Landed in e1ddcb7, thanks! |
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>
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>
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.