Update docstrings

Co-authored-by: David Stansby <[email protected]>

Author: paraseba

src/zarr/abc/store.py

@@ -267,11 +267,11 @@ async def _set_many(self, values: Iterable[tuple[str, Buffer]]) -> None:
     @property
     def supports_consolidated_metadata(self) -> bool:
         """
-        Does the store support and benefit from consolidated metadata?.
+        Does the store support consolidated metadata?.
 
-        If it doesn't Zarr will ignore requests to consolidate the metadata.
-        Stores that would return `True` are the ones that implement their own
-        consolidation mechanism, that allows fast querying of metadata keys.
+        If it doesn't an error will be raised on requests to consolidate the metadata.
+        Returning `False` can be useful for stores which implement their own
+        consolidation mechanism outside of the zarr-python implementation.
         """
 
         return True

src/zarr/api/asynchronous.py

@@ -174,8 +174,8 @@ async def consolidate_metadata(
     Consolidate the metadata of all nodes in a hierarchy.
 
     Upon completion, the metadata of the root node in the Zarr hierarchy will be
-    updated to include all the metadata of child nodes. For Stores that prefer
-    not to use consolidated metadata, this operation raises a ``TypeError``.
+    updated to include all the metadata of child nodes. For Stores that do
+    not support consolidated metadata, this operation raises a ``TypeError``.
 
     Parameters
     ----------
@@ -195,9 +195,8 @@ async def consolidate_metadata(
     -------
     group: AsyncGroup
         The group, with the ``consolidated_metadata`` field set to include
-        the metadata of each child node. If the Store doesn't prefer
-        consolidated metadata, this is function does nothing and returns
-        the group without modifications. See ``Store.supports_consolidated_metadata``.
+        the metadata of each child node. If the Store doesn't support
+        consolidated metadata, this is function does raises a `TypeError`.
     """
     store_path = await make_store_path(store, path=path)
 

src/zarr/api/synchronous.py

@@ -81,8 +81,8 @@ def consolidate_metadata(
     Consolidate the metadata of all nodes in a hierarchy.
 
     Upon completion, the metadata of the root node in the Zarr hierarchy will be
-    updated to include all the metadata of child nodes. For Stores that prefer
-    not to use consolidated metadata, this operation does nothing.
+    updated to include all the metadata of child nodes. For Stores that do
+    not use consolidated metadata, this operation raises a `TypeError`.
 
     Parameters
     ----------

tests/test_metadata/test_consolidated.py

@@ -662,7 +662,7 @@ def supports_consolidated_metadata(self) -> bool:
 
 
 async def test_consolidate_metadata_raises_for_self_consolidating_stores():
-    """Verify calling consolidate_metadata on a non supporting stores does nothing"""
+    """Verify calling consolidate_metadata on a non supporting stores raises an error."""
 
     memory_store = NonConsolidatedStore()
     root = await zarr.api.asynchronous.create_group(store=memory_store)