JSDoc question/suggestion on optional parameters

bartolkaruza · jonathanong · commit 3d15c2409d97 · 2016-03-12T14:22:42.000-08:00
Hi, Webstorm keeps giving me warnings on the 'redirect' method, because the JSDoc specified two input parameters, both required. There is a JSDoc standard for optional parameters. What is your view on using these in KOA documentation? http://usejsdoc.org/tags-param.html#optional-parameters-and-default-values closes #661
diff --git a/lib/response.js b/lib/response.js
@@ -248,7 +248,7 @@ module.exports = {
    *    this.redirect('http://google.com');
    *
    * @param {String} url
-   * @param {String} alt
+   * @param {String} [alt]
    * @api public
    */
 

Original file line number	Diff line number	Diff line change
`@@ -248,7 +248,7 @@ module.exports = {`
`248`	`248`	`* this.redirect('http://google.com');`
`249`	`249`	`*`
`250`	`250`	`* @param {String} url`
`251`		`- * @param {String} alt`
	`251`	`+ * @param {String} [alt]`
`252`	`252`	`* @api public`
`253`	`253`	`*/`
`254`	`254`