Skip to content

Commit 024d95d

Browse files
committed
Add note to .order property
1 parent 70d1bac commit 024d95d

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/zarr/core/array.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1049,6 +1049,14 @@ def order(self) -> MemoryOrder:
10491049
-------
10501050
bool
10511051
Memory order of the array
1052+
1053+
Notes
1054+
-----
1055+
For Zarr format 2 arrays this is the memory order in which
1056+
data is stored and returned when read in to a NumPy array.
1057+
1058+
For Zarr format 3 arrays this is just the memory order
1059+
in which data is returned when read into a NumPy array.
10521060
"""
10531061
if self.metadata.zarr_format == 2:
10541062
return self.metadata.order

0 commit comments

Comments
 (0)