TheThing/koa-lite
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

JSDoc question/suggestion on optional parameters

Browse source 
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
This commit is contained in:
Bartol Karuza 2016-02-22 11:33:08 +01:00 committed by Jonathan Ong
parent d768ed83b6
commit 3d15c2409d
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
lib/response.js
View file

@ -248,7 +248,7 @@ module.exports = {
* this.redirect('http://google.com'); * this.redirect('http://google.com');
* *
* @param {String} url * @param {String} url
* @param {String} alt * @param {String} [alt]
* @api public * @api public
*/ */