(chore): docs note

scverse · Nov 28, 2024 · 0c777ef · 0c777ef
1 parent 1ab575c
commit 0c777ef
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/src/anndata/experimental/backed/_lazy_arrays.py b/src/anndata/experimental/backed/_lazy_arrays.py
@@ -48,6 +48,12 @@ def __getitem__(self, key: xr.core.indexing.ExplicitIndexer):
 
 
 class CategoricalArray(BackendArray, Generic[K]):
+    """
+    A wrapper class meant to enable working with lazy categorical data.
+    We do not guarantee the stability of this API beyond that guaranteed
+    by :class:`xarray.backends.BackendArray`.
+    """
+
     _codes: ZarrOrHDF5Wrapper[K]
     _categories: ZarrArray | H5Array
     shape: tuple[int, ...]
@@ -97,6 +103,12 @@ def dtype(self):
 
 
 class MaskedArray(BackendArray, Generic[K]):
+    """
+    A wrapper class meant to enable working with lazy masked data.
+    We do not guarantee the stability of this API beyond that guaranteed
+    by :class:`xarray.backends.BackendArray`.
+    """
+
     _mask: ZarrOrHDF5Wrapper[K]
     _values: ZarrOrHDF5Wrapper[K]
     _dtype_str: Literal["nullable-integer", "nullable-boolean"]