Skip to content

Commit 7f5b7ce

Browse files
committed
better docstring
1 parent f7ad81a commit 7f5b7ce

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/spatialdata_io/readers/_utils/_image.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,12 @@ def _read_chunks(
104104
)`, we use the more common `(y, x)` ordering: the inner list (dim = -1) iterates
105105
over `x` values, and the outer list (dim = -2) iterates over `y` values.
106106
107-
This mismatch can be confusing. A straightforward fix is to standardize `coords`
108-
to `(y, x, height, width)` instead of `(x, y, width, height)`.
107+
This mismatch can be confusing. A straightforward fix that one could perform would
108+
be to standardize `coords` to `(y, x, height, width)` instead of
109+
`(x, y, width, height)`.
109110
"""
111+
# TODO: standardize `coords` as explained in the docstring above, then remove that
112+
# part from the docstring
110113
func_kwargs = func_kwargs if func_kwargs else {}
111114

112115
# Collect each delayed chunk as item in list of list

0 commit comments

Comments
 (0)