From eb011cd99ba03f40f4ed7a023b64f93dfa2cbdc9 Mon Sep 17 00:00:00 2001
From: Daniel Wagner-Hall <daniel@matrix.org>
Date: Tue, 22 Sep 2015 13:29:36 +0100
Subject: Add docstring

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

(limited to 'synapse')

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()
 
-- 
cgit 1.4.1