Skip to content

Commit

Permalink
add missing arg docstrs
Browse files Browse the repository at this point in the history
  • Loading branch information
@ryan-williams
ryan-williams committed Nov 8, 2024
1 parent 2d49131 commit bb87910
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 0 deletions.
11 changes: 11 additions & 0 deletions python-spec/src/somacore/data.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,11 @@ def create(
the minimum and maximum possible values for the column's
datatype. This makes a dataframe growable.
platform_config: platform-specific configuration; keys are SOMA
implementation names.
context: Other implementation-specific configuration.
Returns:
The newly created dataframe, opened for writing.
Expand Down Expand Up @@ -326,6 +331,8 @@ def read(
a partitioned read, and which part of the data to include.
result_order: the order to return results, specified as a
:class:`~options.ResultOrder` or its string value.
platform_config: platform-specific configuration; keys are SOMA
implementation names.
Returns: The data over the requested range as a tensor.
Expand Down Expand Up @@ -426,6 +433,8 @@ def read(
and which partition to include, if present.
result_order: the order to return results, specified as a
:class:`~options.ResultOrder` or its string value.
platform_config: platform-specific configuration; keys are SOMA
implementation names.
Returns: The data that was requested in a :class:`SparseRead`,
allowing access in any supported format.
Expand Down Expand Up @@ -479,6 +488,8 @@ def write(
Arrow table: a COO table, with columns named ``soma_dim_0``,
..., ``soma_dim_N`` and ``soma_data``.
platform_config: platform-specific configuration; keys are SOMA
implementation names.
Returns: ``self``, to enable method chaining.
Expand Down
2 changes: 2 additions & 0 deletions python-spec/src/somacore/query/query.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,8 @@ def X(
and which partition to include, if present.
result_order: the order to return results, specified as a
:class:`~options.ResultOrder` or its string value.
platform_config: platform-specific configuration; keys are SOMA
implementation names.
Lifecycle: maturing
"""
Expand Down
28 changes: 28 additions & 0 deletions python-spec/src/somacore/spatial.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,9 @@ def create(
or if ``None`` in a given dimension, the corresponding index-column
domain will use the minimum and maximum possible values for the
column's datatype. This makes a point cloud dataframe growable.
platform_config: platform-specific configuration; keys are SOMA
implementation names.
context: Other implementation-specific configuration.
Returns:
The newly created geometry dataframe, opened for writing.
Expand Down Expand Up @@ -122,6 +125,8 @@ def read(
Defaults to ``()``, meaning no constraint -- all IDs.
column_names: the named columns to read and return.
Defaults to ``None``, meaning no constraint -- all column names.
batch_size: The size of batches that should be returned from a read.
See :class:`options.BatchSize` for details.
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 All @@ -130,6 +135,8 @@ def read(
The default of ``None`` represents no filter. Value filter
syntax is implementation-defined; see the documentation
for the particular SOMA implementation for details.
platform_config: platform-specific configuration; keys are SOMA
implementation names.
Returns:
A :class:`ReadIter` of :class:`pa.Table`s.
Expand Down Expand Up @@ -177,6 +184,8 @@ def read_spatial_region(
The default of ``None`` represents no filter. Value filter
syntax is implementation-defined; see the documentation
for the particular SOMA implementation for details.
platform_config: platform-specific configuration; keys are SOMA
implementation names.
Returns:
A :class:`SpatialRead` with :class:`ReadIter` of :class:`pa.Table`s data.
Expand All @@ -201,6 +210,8 @@ def write(
values: An Arrow table containing all columns, including
the index columns. The schema for the values must match
the schema for the ``DataFrame``.
platform_config: platform-specific configuration; keys are SOMA
implementation names.
Returns: ``self``, to enable method chaining.
Expand Down Expand Up @@ -323,6 +334,9 @@ def create(
the corresponding index-column domain will use the minimum and maximum
possible values for the column's datatype. This makes a dataframe
growable.
platform_config: platform-specific configuration; keys are SOMA
implementation names.
context: Other implementation-specific configuration.
Returns:
The newly created geometry dataframe, opened for writing.
Expand Down Expand Up @@ -352,6 +366,8 @@ def read(
Defaults to ``()``, meaning no constraint -- all IDs.
column_names: the named columns to read and return.
Defaults to ``None``, meaning no constraint -- all column names.
batch_size: The size of batches that should be returned from a read.
See :class:`options.BatchSize` for details.
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 All @@ -360,6 +376,8 @@ def read(
The default of ``None`` represents no filter. Value filter
syntax is implementation-defined; see the documentation
for the particular SOMA implementation for details.
platform_config: platform-specific configuration; keys are SOMA
implementation names.
Returns:
A :class:`ReadIter` of :class:`pa.Table`s.
Expand Down Expand Up @@ -407,6 +425,8 @@ def read_spatial_region(
The default of ``None`` represents no filter. Value filter
syntax is implementation-defined; see the documentation
for the particular SOMA implementation for details.
platform_config: platform-specific configuration; keys are SOMA
implementation names.
Returns:
A :class:`SpatialRead` with :class:`ReadIter` of :class:`pa.Table`s data.
Expand All @@ -431,6 +451,8 @@ def write(
values: An Arrow table containing all columns, including
the index columns. The schema for the values must match
the schema for the ``DataFrame``.
platform_config: platform-specific configuration; keys are SOMA
implementation names.
Returns: ``self``, to enable method chaining.
Expand Down Expand Up @@ -563,6 +585,10 @@ def create(
axis is provided, this defaults to the channel axis followed by the
coordinate space axes in reverse order (e.g.
``("soma_channel", "y", "x")`` if ``coordinate_space=("x", "y")``).
has_channel_axis: Save the image with a dedicated "channel" axis.
platform_config: platform-specific configuration; keys are SOMA
implementation names.
context: Other implementation-specific configuration.
Returns:
The newly created collection, opened for writing.
Expand Down Expand Up @@ -663,6 +689,8 @@ def read_spatial_region(
:class:`~options.ResultOrder` or its string value. This is the result
order the data is read from disk. It may be permuted if
``data_axis_order`` is not the default order.
platform_config: platform-specific configuration; keys are SOMA
implementation names.
Returns:
The data bounding the requested region as a :class:`SpatialRead` with
Expand Down

0 comments on commit bb87910

Please sign in to comment.