diff options
author | Daniel Wagner-Hall <daniel@matrix.org> | 2015-08-11 16:35:28 +0100 |
---|---|---|
committer | Daniel Wagner-Hall <daniel@matrix.org> | 2015-08-11 16:35:28 +0100 |
commit | 88e03da39f3746f7d754150964da064772b6ba5f (patch) | |
tree | ec701c5a19a0cd7749a5e74879ae25f8bf1a014f /synapse/api | |
parent | Remove redundant if-guard (diff) | |
download | synapse-88e03da39f3746f7d754150964da064772b6ba5f.tar.xz |
Minor docs cleanup
Diffstat (limited to 'synapse/api')
-rw-r--r-- | synapse/api/auth.py | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/synapse/api/auth.py b/synapse/api/auth.py index bf02347f6a..0eef7442eb 100644 --- a/synapse/api/auth.py +++ b/synapse/api/auth.py @@ -44,6 +44,11 @@ class Auth(object): def check(self, event, auth_events): """ Checks if this event is correctly authed. + Args: + event: the event being checked. + auth_events (dict: event-key -> event): the existing room state. + + Returns: True if the auth checks pass. """ @@ -319,7 +324,7 @@ class Auth(object): Returns: tuple : of UserID and device string: User ID object of the user making the request - Client ID object of the client instance the user is using + ClientInfo object of the client instance the user is using Raises: AuthError if no user by that token exists or the token is invalid. """ @@ -352,7 +357,7 @@ class Auth(object): ) return except KeyError: - pass # normal users won't have this query parameter set + pass # normal users won't have the user_id query parameter set. user_info = yield self.get_user_by_token(access_token) user = user_info["user"] |