Add docstrings for almost all models

Also adds docstring to some managers and model methods.

Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>
This commit is contained in:
Roberto Rosario
2018-11-24 22:56:35 -04:00
parent 8c98679687
commit b04b205fb6
19 changed files with 252 additions and 20 deletions

View File

@@ -14,6 +14,11 @@ logger = logging.getLogger(__name__)
class LockManager(models.Manager):
def acquire_lock(self, name, timeout=None):
"""
Attempts to acquire a lock. Return a LockError is the lock is already
held by someone else or if is not possible to acquire the lock due to
database or operational errors.
"""
logger.debug('trying to acquire lock: %s', name)
lock = self.model(name=name, timeout=timeout)