Fixed docstrings

This commit is contained in:
Joel Collins 2019-01-24 16:24:14 +00:00
parent 80cc74bd3d
commit 465ed647d3
6 changed files with 58 additions and 58 deletions

View file

@ -4,10 +4,10 @@ from openflexure_microscope.exceptions import LockError
class StrictLock(object):
"""
Class that behaves like a Python RLock, but with stricter timeout conditions and custom exceptions.
"""
def __init__(self, timeout=1):
"""
Class that behaves like a Python RLock, but with stricter timeout conditions and custom exceptions.
"""
self._lock = RLock()
self.timeout = timeout
@ -29,11 +29,11 @@ class StrictLock(object):
class CompositeLock(object):
"""
Class that behaves like a :py:class:`openflexure_microscope.lock.StrictLock`,
but allows multiple locks to be acquired and released.
"""
def __init__(self, locks, timeout=1):
"""
Class that behaves like a :py:class:`openflexure_microscope.lock.StrictLock`,
but allows multiple locks to be acquired and released.
"""
self.locks = locks
self.timeout = timeout