export tiledbsoma.SparseNDArrayRead, include in module doc site

fixes #2502
single-cell-data · May 10, 2024 · 6f66111 · 6f66111
1 parent 18c3e6c
commit 6f66111
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/apis/python/src/tiledbsoma/__init__.py b/apis/python/src/tiledbsoma/__init__.py
@@ -165,7 +165,7 @@
 )
 from ._indexer import IntIndexer, tiledbsoma_build_index
 from ._measurement import Measurement
-from ._sparse_nd_array import SparseNDArray
+from ._sparse_nd_array import SparseNDArray, SparseNDArrayRead
 from .options import SOMATileDBContext, TileDBCreateOptions
 from .pytiledbsoma import (
     tiledbsoma_stats_disable,
@@ -205,6 +205,7 @@
     "SOMAError",
     "SOMATileDBContext",
     "SparseNDArray",
+    "SparseNDArrayRead",
     "TileDBCreateOptions",
     "tiledbsoma_build_index",
     "tiledbsoma_stats_disable",

diff --git a/apis/python/src/tiledbsoma/_sparse_nd_array.py b/apis/python/src/tiledbsoma/_sparse_nd_array.py
@@ -506,7 +506,8 @@ def __init__(
 
 
 class SparseNDArrayRead(_SparseNDArrayReadBase):
-    """Intermediate type to choose result format when reading a sparse array.
+    """:class:`SparseNDArrayRead` is an intermediate type which supports multiple eventual result formats
+     when reading a sparse array.
 
     Results returned by `coos` and `tables` iterate over COO coordinates in the user-specified result order,
     but with breaks between iterator steps at arbitrary coordinates (i.e., any given result may split a row or

diff --git a/doc/source/python-tiledbsoma.rst b/doc/source/python-tiledbsoma.rst
@@ -18,9 +18,10 @@ Classes
 
     tiledbsoma.DataFrame
     tiledbsoma.SparseNDArray
+    tiledbsoma.SparseNDArrayRead
     tiledbsoma.DenseNDArray
 
-      tiledbsoma.ResultOrder
+    tiledbsoma.ResultOrder
 
     tiledbsoma.AxisColumnNames
     tiledbsoma.AxisQuery
@@ -56,4 +57,4 @@ Functions
     tiledbsoma.tiledbsoma_stats_disable
     tiledbsoma.tiledbsoma_stats_dump
     tiledbsoma.tiledbsoma_stats_enable
-    tiledbsoma.tiledbsoma_stats_reset
+    tiledbsoma.tiledbsoma_stats_reset