summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--synapse/storage/_base.py6
1 files changed, 6 insertions, 0 deletions
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