Skip to content

Commit

Permalink
PointCloudDataFrame: comment/docstring errata (#3202)
Browse files Browse the repository at this point in the history
  • Loading branch information
ryan-williams authored Oct 18, 2024
1 parent 4e3b70f commit 60bdcf5
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions apis/python/src/tiledbsoma/_point_cloud_dataframe.py
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ def create(
index_column_names: A list of column names to use as user-defined index
columns (e.g., ``['x', 'y']``). All named columns must exist in the
schema, and at least one index column name is required.
Default is ``("soma_joinid", "x", "y")``.
Default is ``("soma_joinid", *coordinate_space)``.
coordinate_space: Either the coordinate space or the axis names for the
coordinate space the point cloud is defined on.
domain: An optional sequence of tuples specifying the domain of each
Expand Down Expand Up @@ -276,7 +276,7 @@ def __init__(
# Data operations

def __len__(self) -> int:
"""Returns the number of rows in the point cound dataframe."""
"""Returns the number of rows in the point cloud dataframe."""
return self.count

@property
Expand Down Expand Up @@ -360,7 +360,7 @@ def read_spatial_region(
value_filter: Optional[str] = None,
platform_config: Optional[options.PlatformConfig] = None,
) -> somacore.SpatialRead[somacore.ReadIter[pa.Table]]:
"""Reads data intersecting an user-defined region of space into a
"""Reads data intersecting a user-defined region of space into a
:class:`SpatialRead` with data in Arrow tables.
Args:
Expand All @@ -376,7 +376,7 @@ def read_spatial_region(
region_coord_space: An optional coordinate space for the region being read.
Defaults to ``None``, coordinate space will be inferred from transform.
batch_size: The size of batched reads.
Defaults to `unbatched`.
Defaults to ``_UNBATCHED``.
partitions: If present, specifies that this is part of a partitioned read,
and which part of the data to include.
result_order: the order to return results, specified as a
Expand Down Expand Up @@ -425,7 +425,7 @@ def read_spatial_region(
coords, data_region, inv_transform = process_spatial_df_region(
region,
region_transform,
dict(), # Move index value_filters into this dict to optimize queries
dict(), # Move index value_filters into this dict to optimize queries
self._tiledb_dim_names(),
self._coord_space.axis_names,
self._handle.schema,
Expand Down

0 comments on commit 60bdcf5

Please sign in to comment.