Skip to content

Commit 221b95f

Browse files
committed
Explain order of consolidated metadata keys in user guide
1 parent 4c8dcbc commit 221b95f

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/user-guide/consolidated_metadata.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,11 @@ With nested groups, the consolidated metadata is available on the children, recu
100100
>>> consolidated['child'].metadata.consolidated_metadata
101101
ConsolidatedMetadata(metadata={'child': GroupMetadata(attributes={'kind': 'grandchild'}, zarr_format=3, consolidated_metadata=ConsolidatedMetadata(metadata={}, kind='inline', must_understand=False), node_type='group')}, kind='inline', must_understand=False)
102102

103+
The keys in the consolidated metadata are sorted in ascending order by path
104+
length, where a path is defined as a sequence of strings joined by '/'. For
105+
keys with the same path length, lexicographic order is used to break the tie.
106+
This behaviour ensures deterministic metadata output for a given group.
107+
103108
Synchronization and Concurrency
104109
-------------------------------
105110

0 commit comments

Comments
 (0)