Skip to content

Fix docstring parameter names that do not match the signatures #1254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Tomaz-Vieira merged 1 commit into from
Sep 24, 2026
Merged

Fix docstring parameter names that do not match the signatures #1254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/spatialdata/_core/operations/rasterize_bins.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ def rasterize_bins(
The key(s) (obs columns/var names) in the table that will be used to rasterize the bins.
If `None`, all the var names will be used, and the returned object will be lazily constructed.
Ignored if `return_region_as_labels` is `True`.
return_regions_as_labels
return_region_as_labels
If `False` this function returns a `xarray.DataArray` of shape `(c, y, x)` with dimension
of `c` equal to the number of key(s) specified in `value_key`, or the number of var names
in `table_name` if `value_key` is `None`. If `True`, will return labels of shape `(y, x)`,
Expand Down Expand Up @@ -280,7 +280,7 @@ def rasterize_bins_link_table_to_labels(sdata: SpatialData, table_name: str, ras
Change the annotation target of the table to the rasterized labels.

This function should be called after having rasterized the bins (calling `rasterize_bins()` with
`return_regions_as_labels=True`) and after having added the rasterized labels to the spatial data object.
`return_region_as_labels=True`) and after having added the rasterized labels to the spatial data object.

Parameters
----------
Expand Down
4 changes: 2 additions & 2 deletions src/spatialdata/_core/spatialdata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2427,8 +2427,8 @@ def subset(
----------
element_names
The names of the element_names to subset. If the element_name is the name of a table, this table would be
completely included in the subset even if filter_table is True.
filter_table
completely included in the subset even if `filter_tables` is True.
filter_tables
If True (default), the table is filtered to only contain rows that are annotating regions
contained within the element_names.
include_orphan_tables
Expand Down
2 changes: 1 addition & 1 deletion src/spatialdata/models/_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ def validate_axes(axes: tuple[ValidAxis_t, ...]) -> None:

Parameters
----------
axis
axes
The names of the axes

Raises
Expand Down
Loading