From bb0a475c30e63a6d9d749a1f8587582904d3ff92 Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Mon, 10 Aug 2015 14:27:38 +0100
Subject: Comments

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

(limited to 'synapse/storage/_base.py')

diff --git a/synapse/storage/_base.py b/synapse/storage/_base.py
index 27713e8b74..826c393cd4 100644
--- a/synapse/storage/_base.py
+++ b/synapse/storage/_base.py
@@ -234,6 +234,12 @@ class CacheDescriptor(object):
 
 
 class CacheListDescriptor(object):
+    """Wraps an existing cache to support bulk fetching of keys.
+
+    Given a list of keys it looks in the cache to find any hits, then passes
+    the list of missing keys to the wrapped fucntion.
+    """
+
     def __init__(self, orig, cache, list_name, num_args=1, inlineCallbacks=False):
         self.orig = orig
 
-- 
cgit 1.4.1