Skip to content

Commit f7ad81a

Browse files
committed
better english
1 parent 3b296da commit f7ad81a

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

src/spatialdata_io/readers/_utils/_image.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -98,14 +98,14 @@ def _read_chunks(
9898
9999
Notes
100100
-------
101-
As seen in _compute_chunks(), since coords are in format (x, y, width, height), the
102-
inner list there (dim=-1) runs over the y values and the outer list (dim=-2) runs
103-
over the x values. In _read_chunks() we have the more common (y, x) format, where
104-
the inner list (dim=-1) runs over the x values and the outer list (dim=-2) runs over
105-
the y values.
106-
107-
The above can be confusing, and a way to address this is to define coords to be
108-
in format (y, x, height, width) instead of (x, y, width, height).
101+
As shown in `_compute_chunks()`, `coords` are in the form `(x, y,
102+
width, height)`. In that function, the inner list (dim = -1) iterates over `y`
103+
values, and the outer list (dim = -2) iterates over `x` values. In `_read_chunks(
104+
)`, we use the more common `(y, x)` ordering: the inner list (dim = -1) iterates
105+
over `x` values, and the outer list (dim = -2) iterates over `y` values.
106+
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)`.
109109
"""
110110
func_kwargs = func_kwargs if func_kwargs else {}
111111

0 commit comments

Comments
 (0)