aljaz/python-teos
1
0
Fork 0
mirror of https://github.com/aljazceru/python-teos.git synced 2025-12-17 22:24:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improves docstrings

Browse Source
This commit is contained in:
Sergi Delgado Segura
2020-04-17 18:03:12 +02:00
parent eea12a695e
commit 2e6095971d
7 changed files with 25 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
teos/appointments_dbm.py
View File

@@ -84,7 +84,7 @@ class AppointmentsDBM(DBManager):
``RESPONDER_LAST_BLOCK_KEY``).
Returns:
:obj:`str` or :obj:`None`: A 16-byte hex-encoded str representing the last known block hash.
:obj:`str` or :obj:`None`: A 32-byte hex-encoded str representing the last known block hash.
Returns ``None`` if the entry is not found.
"""
@@ -177,7 +177,7 @@ class AppointmentsDBM(DBManager):
Args:
uuid (:obj:`str`): the identifier of the appointment to be stored.
appointment (:obj:`dict`): an appointment encoded as dictionary.
appointment (:obj:`dict`): an appointment encoded as a dictionary.
Returns:
:obj:`bool`: True if the appointment was stored in the db. False otherwise.
@@ -202,7 +202,7 @@ class AppointmentsDBM(DBManager):
Args:
uuid (:obj:`str`): the identifier of the appointment to be stored.
tracker (:obj:`dict`): a tracker encoded as dictionary.
tracker (:obj:`dict`): a tracker encoded as a dictionary.
Returns:
:obj:`bool`: True if the tracker was stored in the db. False otherwise.
@@ -247,7 +247,7 @@ class AppointmentsDBM(DBManager):
def create_append_locator_map(self, locator, uuid):
"""
Creates (or appends to if already exists) a ``locator:uuid`` map.
Creates a ``locator:uuid`` map.
If the map already exists, the new ``uuid`` is appended to the existing ones (if it is not already there).
@@ -334,7 +334,7 @@ class AppointmentsDBM(DBManager):
def batch_delete_watcher_appointments(self, uuids):
"""
Deletes an appointment from the database.
Deletes multiple appointments from the database.
Args:
uuids (:obj:`list`): a list of 16-byte hex-encoded strings identifying the appointments to be deleted.
@@ -367,7 +367,7 @@ class AppointmentsDBM(DBManager):
def batch_delete_responder_trackers(self, uuids):
"""
Deletes an appointment from the database.
Deletes multiple trackers from the database.
Args:
uuids (:obj:`list`): a list of 16-byte hex-encoded strings identifying the trackers to be deleted.