summary refs log tree commit diff
path: root/synapse/storage
diff options
context:
space:
mode:
authorDaniel Wagner-Hall <daniel@matrix.org>2015-09-22 13:29:36 +0100
committerDaniel Wagner-Hall <daniel@matrix.org>2015-09-22 13:29:36 +0100
commiteb011cd99ba03f40f4ed7a023b64f93dfa2cbdc9 (patch)
tree6c51501e95eb923454361952061f1493fc989039 /synapse/storage
parentFront-load spaces (diff)
downloadsynapse-eb011cd99ba03f40f4ed7a023b64f93dfa2cbdc9.tar.xz
Add docstring
Diffstat (limited to 'synapse/storage')
-rw-r--r--synapse/storage/events.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/synapse/storage/events.py b/synapse/storage/events.py
index 2b51db9940..46df6b4d6d 100644
--- a/synapse/storage/events.py
+++ b/synapse/storage/events.py
@@ -908,6 +908,12 @@ class EventsStore(SQLBaseStore):
 
     @defer.inlineCallbacks
     def count_daily_messages(self):
+        """
+        Returns an estimate of the number of messages sent in the last day.
+
+        If it has been significantly less or more than one day since the last
+        call to this function, it will return None.
+        """
         def _count_messages(txn):
             now = self.hs.get_clock().time()