More docstring improvements

Author: paraseba

docs/user-guide/consolidated_metadata.rst

@@ -128,5 +128,9 @@ may be for several reasons like:
 
 This type of store can declare it doesn't want consolidation by implementing
 `Store.supports_consolidated_metadata`. For stores that don't support
-consolidation, Zarr will silently ignore any `consolidate_metadata` calls,
-maintaining the store in its unconsolidated state.
+consolidation, Zarr will:
+
+* Raise an error on `consolidate_metadata` calls, maintaining the store in
+  its unconsolidated state.
+* Raise an error in `AsyncGroup.open(..., use_consolidated=True)`
+* Not use consolidated metadata in `AsyncGroup.open(..., use_consolidated=None)`

src/zarr/api/asynchronous.py

@@ -196,7 +196,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 support
-        consolidated metadata, this is function does raises a `TypeError`.
+        consolidated metadata, this function raises a `TypeError`.
+        See ``Store.supports_consolidated_metadata``.
     """
     store_path = await make_store_path(store, path=path)
 

src/zarr/api/synchronous.py

@@ -102,9 +102,9 @@ def consolidate_metadata(
     -------
     group: Group
         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 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 function raises a `TypeError`.
+        See ``Store.supports_consolidated_metadata``.
 
     """
     return Group(sync(async_api.consolidate_metadata(store, path=path, zarr_format=zarr_format)))