Update docs/source/storage.rst

hdmf-dev · Dec 5, 2023 · b75b279 · b75b279
1 parent d8b5841
commit b75b279
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/docs/source/storage.rst b/docs/source/storage.rst
@@ -401,3 +401,10 @@ Consolidating Metadata
 Zarr allows users to consolidate all metadata for groups and arrays within the given store. By default, every file
 will consolidate all metadata within into a single `.zmetadata` file, stored in the root group. This reduces the number of read
 operations when retrieving certain metadata in read mode.
+
+.. note::
+
+    When updating a file, the consolidated metadata will also need to be updated via 
+    `zarr.consolidate_metadata(path)` to ensure the consolidated metadata is consistent 
+    with the file.
+