Clarify which event is returned by check_user_was_in_room

This commit is contained in:
Mark Haines 2015-09-21 13:47:44 +01:00
parent e2054ce21a
commit 8e3bbc9bd0
1 changed files with 3 additions and 2 deletions

View File

@ -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(