Update comment to reflect the things a login method must actually do

This commit is contained in:
Emily Stark
2013-12-04 22:29:27 -08:00
parent a812601ca6
commit 9fc73eee9f

View File

@@ -37,9 +37,10 @@ Meteor.user = function () {
// Call a login method on the server.
//
// A login method is a method which on success calls `this.setUserId(id)` on
// the server and returns an object with fields 'id' (containing the user id)
// and 'token' (containing a resume token).
// A login method is a method which on success calls `this.setUserId(id)` and
// `Accounts._setLoginToken` on the server and returns an object with fields
// 'id' (containing the user id), 'token' (containing a resume token), and
// optionally `tokenExpires`.
//
// This function takes care of:
// - Updating the Meteor.loggingIn() reactive data source