Browse Source

Update doc string

sh4nks 11 years ago
parent
commit
0420686a43
1 changed files with 3 additions and 2 deletions
  1. 3 2
      flaskbb/forum/models.py

+ 3 - 2
flaskbb/forum/models.py

@@ -459,6 +459,9 @@ class Topic(db.Model):
 
     def tracker_needs_update(self, forumsread, topicsread):
         """Returns True if the tracker needs an update.
+        Also, if the ``TRACKER_LENGTH`` is configured, it will just recognize
+        topics that are newer than the ``TRACKER_LENGTH`` (in days) as unread.
+
         TODO: Couldn't think of a better name for this method - ideas?
 
         :param forumsread: The ForumsRead object is needed because we also
@@ -495,8 +498,6 @@ class Topic(db.Model):
     def update_read(self, user, forum, forumsread):
         """Updates the topicsread and forumsread tracker for a specified user,
         if the topic contains new posts or the user hasn't read the topic.
-        Also, if the ``TRACKER_LENGTH`` is configured, it will just recognize
-        topics that are newer than the ``TRACKER_LENGTH`` (days) as unread.
         Returns True if the tracker has been updated.
 
         :param user: The user for whom the readstracker should be updated.