From 8a88684736efcb6792d17249e2976caefe00ee3d Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Wed, 9 Mar 2016 16:51:22 +0000
Subject: [PATCH] Add comment

---
 synapse/storage/stream.py | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/synapse/storage/stream.py b/synapse/storage/stream.py
index c9f70a08a..7f4a82752 100644
--- a/synapse/storage/stream.py
+++ b/synapse/storage/stream.py
@@ -184,6 +184,9 @@ class StreamStore(SQLBaseStore):
     @defer.inlineCallbacks
     def get_room_events_stream_for_room(self, room_id, from_key, to_key, limit=0,
                                         order='DESC'):
+        # Note: If from_key is None then we return in topological order. This
+        # is because in that case we're using this as a "get the last few messages
+        # in a room" function, rather than "get new messages since last sync"
         if from_key is not None:
             from_id = RoomStreamToken.parse_stream_token(from_key).stream
         else: