From 842d9b0bcda04a514aeb96aaeb989659ae41321f Mon Sep 17 00:00:00 2001 From: Raymond Feng Date: Mon, 3 Nov 2014 14:07:19 -0800 Subject: [PATCH] Fix the jsdoc for User.login --- common/models/user.js | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/common/models/user.js b/common/models/user.js index 5bd3869c..a07a346d 100644 --- a/common/models/user.js +++ b/common/models/user.js @@ -117,10 +117,12 @@ User.normalizeCredentials = function(credentials, realmRequired, realmDelimiter) * }); * ``` * - * @param {Object} credentials - * @callback {Function} callback - * @param {Error} err - * @param {AccessToken} token + * @param {Object} credentials username/password or email/password + * @param {String[]|String} [include] Optionally set it to "user" to include + * the user info + * @callback {Function} callback Callback function + * @param {Error} err Error object + * @param {AccessToken} token Access token if login is successful */ User.login = function(credentials, include, fn) {