diff options
| author | Mark Haines <mark.haines@matrix.org> | 2015-09-21 13:47:44 +0100 |
|---|---|---|
| committer | Mark Haines <mark.haines@matrix.org> | 2015-09-21 13:47:44 +0100 |
| commit | 8e3bbc9bd01b8d0bd75e28d9c8862e555384e124 (patch) | |
| tree | 48eacbe60327c1b578f3e9c279eb5e7e4c5c0c15 | |
| parent | Allow users to GET individual state events for rooms that they have left (diff) | |
| download | synapse-8e3bbc9bd01b8d0bd75e28d9c8862e555384e124.tar.xz | |
Clarify which event is returned by check_user_was_in_room
| -rw-r--r-- | synapse/api/auth.py | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/synapse/api/auth.py b/synapse/api/auth.py index d8bb64a4af..49a068afb1 100644 --- a/synapse/api/auth.py +++ b/synapse/api/auth.py @@ -146,8 +146,9 @@ class Auth(object): Raises: AuthError if the user was never in the room. Returns: - A deferred membership event for the user if the user was in - the room. + A deferred membership event for the user if the user was in the + room. This will be the join event if they are currently joined to + the room. This will be the leave event if they have left the room. """ if current_state: member = current_state.get( |