From 2a3e822f4494e42c1b118c2fa0132b3a2f13bbfb Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Fri, 7 Apr 2017 13:47:04 +0100
Subject: [PATCH] Comment

---
 synapse/storage/state.py | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/synapse/storage/state.py b/synapse/storage/state.py
index 86e5fdb76b..acd69944c4 100644
--- a/synapse/storage/state.py
+++ b/synapse/storage/state.py
@@ -71,6 +71,15 @@ class StateStore(SQLBaseStore):
 
     @cached(max_entries=100000, iterable=True)
     def get_current_state_ids(self, room_id):
+        """Get the current state event ids for a room based on the
+        current_state_events table.
+
+        Args:
+            room_id (str)
+
+        Returns:
+            deferred: dict of (type, state_key) -> event_id
+        """
         def _get_current_state_ids_txn(txn):
             txn.execute(
                 """SELECT type, state_key, event_id FROM current_state_events