Improve comments on get_user_by_access_token

because I have to reverse-engineer this every time.
This commit is contained in:
Richard van der Hoff committed 2017-11-29 15:52:41 +00:00
1 parent 5a4da5bf78
commit da562bd6a1
1 file changed
+5 -1
+5 -1
View File
@@ -270,7 +270,11 @@ class Auth(object):
rights (str): The operation being performed; the access token must
allow this.
Returns:
dict : dict that includes the user and the ID of their access token.
Deferred[dict]: dict that includes:
`user` (UserID)
`is_guest` (bool)
`token_id` (int|None): access token id. May be None if guest
`device_id` (str|None): device corresponding to access token
Raises:
AuthError if no user by that token exists or the token is invalid.
"""