Skip to content

Commit

Permalink
docs: Mark options object as optional in createServer (#1611)
Browse files Browse the repository at this point in the history
This change corrects the JSDoc annotation and removes errors from
linters and checkers like built-in into VSCode when using the
createMethod without an option object.
  • Loading branch information
peterblazejewicz authored and hekike committed Mar 1, 2018
1 parent 0919f26 commit cf342b9
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion lib/index.js
Expand Up @@ -19,7 +19,7 @@ require('./errorTypes');
*
* @public
* @function createServer
* @param {Object} options - an options object
* @param {Object} [options] - an options object
* @param {String} [options.name="restify"] - Name of the server.
* @param {Router} [options.router=new Router(opts)] - Router
* @param {Object} [options.log=bunyan.createLogger(options.name || "restify")]
Expand Down

0 comments on commit cf342b9

Please sign in to comment.