From 093f7e47ccf318181c262c79bb60ffd3b83edaee Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Mon, 8 May 2017 16:13:51 +0100
Subject: [PATCH] Expand docstring a bit

---
 synapse/storage/events.py | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/synapse/storage/events.py b/synapse/storage/events.py
index d944984d61..2ab44ceaa7 100644
--- a/synapse/storage/events.py
+++ b/synapse/storage/events.py
@@ -1344,11 +1344,17 @@ class EventsStore(SQLBaseStore):
             self._get_event_cache.invalidate((event_id,))
 
     def _get_events_from_cache(self, events, allow_rejected, update_metrics=True):
-        """
+        """Fetch events from the caches
+
         Args:
             events (list(str)): list of event_ids to fetch
             allow_rejected (bool): Whether to teturn events that were rejected
             update_metrics (bool): Whether to update the cache hit ratio metrics
+
+        Returns:
+            dict of event_id -> _EventCacheEntry for each event_id in cache. If
+            allow_rejected is `False` then there will still be an entry but it
+            will be `None`
         """
         event_map = {}