Add docstring

This commit is contained in:
Daniel Wagner-Hall 2015-09-22 13:29:36 +01:00
parent 6d7f291b93
commit eb011cd99b

View File

@ -908,6 +908,12 @@ class EventsStore(SQLBaseStore):
@defer.inlineCallbacks @defer.inlineCallbacks
def count_daily_messages(self): 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): def _count_messages(txn):
now = self.hs.get_clock().time() now = self.hs.get_clock().time()