From 83892d0d3039965ae3075df166cbdbd7339cb0bc Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Wed, 30 Sep 2015 16:41:48 +0100
Subject: [PATCH] Comment

---
 synapse/handlers/federation.py | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/synapse/handlers/federation.py b/synapse/handlers/federation.py
index 3ce1aee52c..17f4ddd325 100644
--- a/synapse/handlers/federation.py
+++ b/synapse/handlers/federation.py
@@ -1013,6 +1013,14 @@ class FederationHandler(BaseHandler):
 
     @defer.inlineCallbacks
     def _persist_auth_tree(self, auth_events, state, event):
+        """Checks the auth chain is valid (and passes auth checks) for the
+        state and event. Then persists the auth chain and state atomically.
+        Persists the event seperately.
+
+        Returns:
+            2-tuple of (event_stream_id, max_stream_id) from the persist_event
+            call for `event`
+        """
         events_to_context = {}
         for e in itertools.chain(auth_events, state):
             ctx = yield self.state_handler.compute_event_context(