summary refs log tree commit diff
path: root/synapse/api/auth.py
diff options
context:
space:
mode:
authorRichard van der Hoff <richard@matrix.org>2016-07-20 15:12:42 +0100
committerRichard van der Hoff <richard@matrix.org>2016-07-20 16:40:28 +0100
commit053e83dafb8d66b010a087d57b0aac108d68036e (patch)
treeaf274e64fd708f39b4db647a9ebb9f2d0cedda43 /synapse/api/auth.py
parentMerge pull request #936 from matrix-org/erikj/log_rss (diff)
downloadsynapse-053e83dafb8d66b010a087d57b0aac108d68036e.tar.xz
More doc-comments
Fix some more comments on some things
Diffstat (limited to 'synapse/api/auth.py')
-rw-r--r--synapse/api/auth.py5
1 files changed, 2 insertions, 3 deletions
diff --git a/synapse/api/auth.py b/synapse/api/auth.py
index be67ab4f4d..ff7d816cfc 100644
--- a/synapse/api/auth.py
+++ b/synapse/api/auth.py
@@ -566,9 +566,8 @@ class Auth(object):
         Args:
             request - An HTTP request with an access_token query parameter.
         Returns:
-            tuple of:
-                UserID (str)
-                Access token ID (str)
+            defer.Deferred: resolves to a namedtuple including "user" (UserID)
+            "access_token_id" (int), "is_guest" (bool)
         Raises:
             AuthError if no user by that token exists or the token is invalid.
         """