From 412ece18e7edb87053a3684e49d5dd485f88a65d Mon Sep 17 00:00:00 2001
From: David Baker <dave@matrix.org>
Date: Mon, 27 Apr 2015 14:08:45 +0100
Subject: Add commentage.

---
 synapse/handlers/auth.py | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'synapse')

diff --git a/synapse/handlers/auth.py b/synapse/handlers/auth.py
index ef3219b38e..2e8009d3c3 100644
--- a/synapse/handlers/auth.py
+++ b/synapse/handlers/auth.py
@@ -121,6 +121,10 @@ class AuthHandler(BaseHandler):
 
     @defer.inlineCallbacks
     def add_oob_auth(self, stagetype, authdict, clientip):
+        """
+        Adds the result of out-of-band authentication into an existing auth
+        session. Currently used for adding the result of fallback auth.
+        """
         if stagetype not in self.checkers:
             raise LoginError(400, "", Codes.MISSING_PARAM)
         if 'session' not in authdict:
-- 
cgit 1.4.1