summary refs log tree commit diff
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2014-09-29 15:35:54 +0100
committerErik Johnston <erik@matrix.org>2014-09-29 15:35:54 +0100
commit7151615260d50c40341fb168bfe804be0d94ec24 (patch)
tree89385b334a5695cb06b7cfb8933247e6f9f301c6
parentSYN-48: Delete dead code (diff)
downloadsynapse-7151615260d50c40341fb168bfe804be0d94ec24.tar.xz
Update docstring
-rw-r--r--synapse/api/auth.py2
-rw-r--r--synapse/storage/registration.py3
2 files changed, 3 insertions, 2 deletions
diff --git a/synapse/api/auth.py b/synapse/api/auth.py
index 8f7982c7fa..e1b1823cd7 100644
--- a/synapse/api/auth.py
+++ b/synapse/api/auth.py
@@ -246,7 +246,7 @@ class Auth(object):
         """ Get a registered user's ID.
 
         Args:
-            token (str)- The access token to get the user by.
+            token (str): The access token to get the user by.
         Returns:
             dict : dict that includes the user, device_id, and whether the
                 user is a server admin.
diff --git a/synapse/storage/registration.py b/synapse/storage/registration.py
index cf43209367..719806f82b 100644
--- a/synapse/storage/registration.py
+++ b/synapse/storage/registration.py
@@ -94,7 +94,8 @@ class RegistrationStore(SQLBaseStore):
         Args:
             token (str): The access token of a user.
         Returns:
-            str: The user ID of the user.
+            dict: Including the name (user_id), device_id and whether they are
+                an admin.
         Raises:
             StoreError if no user was found.
         """