doco

Author: alimanfoo

zarr/array.py

@@ -223,7 +223,7 @@ def _chunk_setitem(self, cidx, key, value):
             Value to set.
 
         """
-        
+
         # override this in sub-classes, e.g., if need to use a lock
 
         if is_total_slice(key, self._chunks):

zarr/sync.py

@@ -7,18 +7,32 @@
 
 
 class ArraySynchronizer(metaclass=ABCMeta):
+    """Abstract class defining the interface to a synchronization manager for a
+    single array."""
 
     @contextmanager
     @abstractmethod
-    def lock_array(self): pass
+    def lock_array(self):
+        """Obtain a lock on the entire array."""
+        pass
 
     @contextmanager
     @abstractmethod
-    def lock_attrs(self): pass
+    def lock_attrs(self):
+        """Obtain a lock on the user-defined attributes."""
+        pass
 
     @contextmanager
     @abstractmethod
-    def lock_chunk(self, key): pass
+    def lock_chunk(self, key):
+        """Obtain a lock on a single chunk.
+
+        Parameters
+        ----------
+        key : tuple of ints
+            Chunk index.
+        """
+        pass
 
 
 class ThreadSynchronizer(ArraySynchronizer):