From fd5ad0f00ec963e9722d9f5bbe526dc84038e408 Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Fri, 21 Aug 2015 11:45:43 +0100
Subject: [PATCH] Doc string
---
synapse/handlers/auth.py | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/synapse/handlers/auth.py b/synapse/handlers/auth.py
index 058a0f416d..602c5bcd89 100644
--- a/synapse/handlers/auth.py
+++ b/synapse/handlers/auth.py
@@ -295,6 +295,12 @@ class AuthHandler(BaseHandler):
@defer.inlineCallbacks
def _find_user_id_and_pwd_hash(self, user_id):
+ """Checks to see if a user with the given id exists. Will check case
+ insensitively, but will throw if there are multiple inexact matches.
+
+ Returns:
+ tuple: A 2-tuple of `(canonical_user_id, password_hash)`
+ """
user_infos = yield self.store.get_users_by_id_case_insensitive(user_id)
if not user_infos:
logger.warn("Attempted to login as %s but they do not exist", user_id)
--
GitLab