Skip to content

Commit

Permalink
#7: Added missing docstrings for status_handler.py.
Browse files Browse the repository at this point in the history
  • Loading branch information
Bystroushaak committed Dec 9, 2015
1 parent 0eca240 commit e75778e
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion src/edeposit/amqp/rest/database/status_handler.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
# Imports =====================================================================
import time
import random
from collections import OrderedDict
from functools import total_ordering

import transaction
Expand Down Expand Up @@ -230,6 +229,11 @@ def save_status_update(self, rest_id, message, timestamp, book_name=None,
"""
Save new status `message` to given `rest_id`.
Warning:
If the tracking for given user wasn't registered using
:meth:`.register_status_tracking`, the status updates for this
user / rest_id will be ignored!
Args:
rest_id (str): Unique identificator of given REST request.
message (str): Content of the status update.
Expand Down Expand Up @@ -387,6 +391,8 @@ def remove_user(self, username):
"""
Remove tracking of the `username`.
If the `username` is not registered, than nothing happens.
Args:
username (str): Name of the user. If the user is not registered,
then it is ignored.
Expand Down

0 comments on commit e75778e

Please sign in to comment.