From a0e8a53c6d0ff65629aa8645d43df06558ff88af Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Mon, 25 Jun 2018 19:57:38 +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 aab69550a..c4ffdf887 100644
--- a/synapse/handlers/federation.py
+++ b/synapse/handlers/federation.py
@@ -460,6 +460,14 @@ class FederationHandler(BaseHandler):
     @measure_func("_filter_events_for_server")
     @defer.inlineCallbacks
     def _filter_events_for_server(self, server_name, room_id, events):
+        """Filter the given events for the given server, redacting those the
+        server can't see.
+
+        Assumes the server is currently in the room.
+
+        Returns
+            list[FrozenEvent]
+        """
         # First lets check to see if all the events have a history visibility
         # of "shared" or "world_readable". If thats the case then we don't
         # need to check membership (as we know the server is in the room).