update function description

7 years ago · e3dc09d0f1
1 changed files with 3 additions and 1 deletions
--- a/tildes/tildes/views/api/web/comment.py
+++ b/tildes/tildes/views/api/web/comment.py
@ -334,7 +334,9 @@ def put_mark_comments_read(
        request: Request,
        clear_all_previous: str = 'false'
 ) -> Response:
-    """Mark a comment read (clear all notifications)."""
+    """Mark comments read clearing notifications and removing them from topics
+    'new' count. if the query param clear_all_previous is 'true' all
+    notifications prior to the target will be cleared."""
    comment = request.context

    if clear_all_previous == 'true':