Skip to content

doc: standardize rest parameters

Rodrigo Muino Tomonari requested to merge github/fork/TimothyGu/std-rest-params into master
Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
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:

Warning: invalid param "..."
 > {"textRaw":"`string` {string} The message to print to `stderr` ","name":"string","type":"string","desc":"The message to print to `stderr`"}
 > util.error([...])

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.

Merge request reports