From 4762c276cb460044099a98a4343c3f2b0ce2abe4 Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Tue, 11 Aug 2015 11:33:41 +0100
Subject: [PATCH] Docs

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

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: