From 6eaa116867ebfd22718505d1aa29dce4679c87be Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Tue, 11 Aug 2015 11:35:24 +0100
Subject: [PATCH] Comment

---
 synapse/storage/_base.py | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/synapse/storage/_base.py b/synapse/storage/_base.py
index bdca61d2ee..4d86fe7c72 100644
--- a/synapse/storage/_base.py
+++ b/synapse/storage/_base.py
@@ -288,6 +288,8 @@ class CacheListDescriptor(object):
             keyargs = [arg_dict[arg_nm] for arg_nm in self.arg_names]
             list_args = arg_dict[self.list_name]
 
+            # cached is a dict arg -> deferred, where deferred results in a
+            # 2-tuple (`arg`, `result`)
             cached = {}
             missing = []
             for arg in list_args: