From 3d15c2409d9797177370c32ef2358cfd47ed7607 Mon Sep 17 00:00:00 2001 From: Bartol Karuza Date: Mon, 22 Feb 2016 11:33:08 +0100 Subject: [PATCH] JSDoc question/suggestion on optional parameters 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 --- lib/response.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/response.js b/lib/response.js index c98986f..1c10068 100644 --- 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 */