Skip to content

Commit 5a7280b

Browse files
committed
Improve docstrings
1 parent 26b4760 commit 5a7280b

File tree

1 file changed

+26
-8
lines changed

1 file changed

+26
-8
lines changed

src/zarr/core/array.py

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1087,15 +1087,20 @@ def chunks(self) -> tuple[int, ...]:
10871087

10881088
@property
10891089
def read_chunk_sizes(self) -> tuple[tuple[int, ...], ...]:
1090-
"""Per-dimension sizes of chunks used for reading.
1090+
"""Per-dimension data sizes of chunks used for reading, clipped to the array extent.
1091+
1092+
Boundary chunks that extend past the array shape are clipped, so
1093+
the last size along a dimension may be smaller than the declared
1094+
chunk size. This matches the dask ``Array.chunks`` convention.
10911095
10921096
When sharding is used, returns the inner chunk sizes.
10931097
Otherwise, returns the outer chunk sizes (same as ``write_chunk_sizes``).
10941098
10951099
Returns
10961100
-------
10971101
tuple[tuple[int, ...], ...]
1098-
One inner tuple per dimension containing chunk sizes.
1102+
One inner tuple per dimension containing the data size of each
1103+
chunk (not the encoded buffer size).
10991104
11001105
Examples
11011106
--------
@@ -1113,14 +1118,18 @@ def read_chunk_sizes(self) -> tuple[tuple[int, ...], ...]:
11131118

11141119
@property
11151120
def write_chunk_sizes(self) -> tuple[tuple[int, ...], ...]:
1116-
"""Per-dimension sizes of chunks used for writing (storage chunks).
1121+
"""Per-dimension data sizes of storage chunks, clipped to the array extent.
11171122
11181123
Always returns the outer chunk sizes, regardless of sharding.
1124+
Boundary chunks that extend past the array shape are clipped, so
1125+
the last size along a dimension may be smaller than the declared
1126+
chunk size. This matches the dask ``Array.chunks`` convention.
11191127
11201128
Returns
11211129
-------
11221130
tuple[tuple[int, ...], ...]
1123-
One inner tuple per dimension containing chunk sizes.
1131+
One inner tuple per dimension containing the data size of each
1132+
chunk (not the encoded buffer size).
11241133
11251134
Examples
11261135
--------
@@ -2378,15 +2387,20 @@ def chunks(self) -> tuple[int, ...]:
23782387

23792388
@property
23802389
def read_chunk_sizes(self) -> tuple[tuple[int, ...], ...]:
2381-
"""Per-dimension sizes of chunks used for reading.
2390+
"""Per-dimension data sizes of chunks used for reading, clipped to the array extent.
2391+
2392+
Boundary chunks that extend past the array shape are clipped, so
2393+
the last size along a dimension may be smaller than the declared
2394+
chunk size. This matches the dask ``Array.chunks`` convention.
23822395
23832396
When sharding is used, returns the inner chunk sizes.
23842397
Otherwise, returns the outer chunk sizes (same as ``write_chunk_sizes``).
23852398
23862399
Returns
23872400
-------
23882401
tuple[tuple[int, ...], ...]
2389-
One inner tuple per dimension containing chunk sizes.
2402+
One inner tuple per dimension containing the data size of each
2403+
chunk (not the encoded buffer size).
23902404
23912405
Examples
23922406
--------
@@ -2398,14 +2412,18 @@ def read_chunk_sizes(self) -> tuple[tuple[int, ...], ...]:
23982412

23992413
@property
24002414
def write_chunk_sizes(self) -> tuple[tuple[int, ...], ...]:
2401-
"""Per-dimension sizes of chunks used for writing (storage chunks).
2415+
"""Per-dimension data sizes of storage chunks, clipped to the array extent.
24022416
24032417
Always returns the outer chunk sizes, regardless of sharding.
2418+
Boundary chunks that extend past the array shape are clipped, so
2419+
the last size along a dimension may be smaller than the declared
2420+
chunk size. This matches the dask ``Array.chunks`` convention.
24042421
24052422
Returns
24062423
-------
24072424
tuple[tuple[int, ...], ...]
2408-
One inner tuple per dimension containing chunk sizes.
2425+
One inner tuple per dimension containing the data size of each
2426+
chunk (not the encoded buffer size).
24092427
24102428
Examples
24112429
--------

0 commit comments

Comments
 (0)