summary refs log tree commit diff
path: root/synapse
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2015-08-11 11:33:41 +0100
committerErik Johnston <erik@matrix.org>2015-08-11 11:33:41 +0100
commit4762c276cb460044099a98a4343c3f2b0ce2abe4 (patch)
tree848972d281257da7626d46ad51eca7b4a63c5014 /synapse
parentRemove debug loggers (diff)
downloadsynapse-4762c276cb460044099a98a4343c3f2b0ce2abe4.tar.xz
Docs
Diffstat (limited to 'synapse')
-rw-r--r--synapse/storage/_base.py9
1 files changed, 9 insertions, 0 deletions
diff --git a/synapse/storage/_base.py b/synapse/storage/_base.py
index 826c393cd4..bdca61d2ee 100644
--- a/synapse/storage/_base.py
+++ b/synapse/storage/_base.py
@@ -241,6 +241,15 @@ class CacheListDescriptor(object):
     """
 
     def __init__(self, orig, cache, list_name, num_args=1, inlineCallbacks=False):
+        """
+        Args:
+            orig (function)
+            cache (Cache)
+            list_name (str): Name of the argument which is the bulk lookup list
+            num_args (int)
+            inlineCallbacks (bool): Whether orig is a generator that should
+                be wrapped by defer.inlineCallbacks
+        """
         self.orig = orig
 
         if inlineCallbacks: