slice object -> slice item

Author: forman

zappend/config/config.py

@@ -114,22 +114,24 @@ def target_dir(self) -> FileObj:
 
     @property
     def slice_engine(self) -> str | None:
-        """The configured slice engine to be used if a slice object is not a Zarr.
+        """The configured slice engine to be used if a slice path or URI does not
+        point to a dataset in Zarr format.
         If defined, it will be passed to the `xarray.open_dataset()` function.
         """
         return self._config.get("slice_engine")
 
     @property
     def slice_source(self) -> Callable[[...], Any] | None:
         """The configured slice source type. If given, it must be
-        a callable that returns a `SliceObj` or a class that is derived from
-         `SliceSource` or implements its interface."""
+        a callable that returns a value of type `SliceItem` or a class that is
+        derived from `SliceSource` abstract base class.
+        """
         return self._slice_source
 
     @property
     def slice_storage_options(self) -> dict[str, Any] | None:
         """The configured slice storage options to be used
-        if a slice object is a Zarr.
+        if a slice item is a URI.
         """
         return self._config.get("slice_storage_options")
 

zappend/processor.py

@@ -63,14 +63,14 @@ def process_slices(self, slices: Iterable[SliceItem]):
         Passes each slice in `slices` to the `process_slice()` method.
 
         Args:
-            slices: Slice objects.
+            slices: Iterable of slice items.
         """
         with self._profiler:
             for slice_index, slice_item in enumerate(slices):
                 self.process_slice(slice_item, slice_index=slice_index)
 
     def process_slice(self, slice_item: SliceItem, slice_index: int = 0):
-        """Process a single slice object *slice_item*.
+        """Process a single slice item *slice_item*.
 
         If there is no target yet, just config and slice:
 
@@ -89,7 +89,7 @@ def process_slice(self, slice_item: SliceItem, slice_index: int = 0):
         * update target from slice
 
         Args:
-            slice_item: The slice object.
+            slice_item: The slice item.
             slice_index: An index identifying the slice.
         """
 

zappend/slice/cm.py

@@ -39,7 +39,7 @@ def open_slice_dataset(
     slice_item: Any,
     slice_index: int = 0,
 ) -> SliceSourceContextManager:
-    """Open the slice source for given slice object `slice_item`.
+    """Open the slice source for given slice item `slice_item`.
 
     The intended and only use of the returned slice source is as context
     manager. When used as context manager the slice source yields a slice
@@ -58,7 +58,7 @@ class derived from `zappend.slice.SliceSource` or a function that returns
     * `dict`: keyword arguments only;
     * Any other type is interpreted as single positional argument.
 
-    If `slice_source` is not specified in the configuration, the slice object
+    If `slice_source` is not specified in the configuration, the slice item
     `slice_item` may have one of the following types:
 
     * `str`: A local file path or URI pointing to a dataset file such as a