remove references to private API

Author: d-v-b

changes/3299.bugfix.rst

@@ -1,6 +1,4 @@
 Fix a bug in ``create_array`` caused by iterating over chunk-aligned regions instead of
-shard-aligned regions when writing data. To make the distinction between chunks and shards more
-obvious in the ``Array`` API, new properties ``chunk_grid_shape``,
-``shard_grid_shape``, ``nshards``, ``nshards_initialized`` were added to the ``Array`` class.
-Additionally, the behavior of ``nchunks_initialized`` has been adjusted. This function consistently
-reports the number of chunks present in stored objects, even when the array uses the sharding codec.
+shard-aligned regions when writing data. Additionally, the behavior of ``nchunks_initialized``
+has been adjusted. This function consistently reports the number of chunks present in stored objects,
+even when the array uses the sharding codec.

docs/user-guide/performance.rst

@@ -211,7 +211,7 @@ the time required to write an array with different values.::
    ...         start = time.time()
    ...         arr[:] = value
    ...         elapsed = time.time() - start
-   ...         result.append((elapsed, arr.nshards_initialized))
+   ...         result.append((elapsed, arr.nchunks_initialized))
    ...     return result
    ... # log results
    >>> for write_empty_chunks in (True, False):

src/zarr/core/array.py

@@ -1275,8 +1275,6 @@ async def nchunks_initialized(self) -> int:
         >>> await arr.nchunks_initialized()
         0
         >>> await arr.setitem(slice(5), 1)
-        >>> await arr.nshards_initialized()
-        3
         >>> await arr.nchunks_initialized()
         6
         """
@@ -1302,15 +1300,15 @@ async def _nshards_initialized(self) -> int:
         Notes
         -----
         On :class:`AsyncArray` this is an asynchronous method, unlike the (synchronous)
-        property :attr:`Array.nshards_initialized`.
+        property :attr:`Array._nshards_initialized`.
 
         Examples
         --------
         >>> arr = await zarr.api.asynchronous.create(shape=(10,), chunks=(2,))
-        >>> await arr.nshards_initialized()
+        >>> await arr._nshards_initialized()
         0
         >>> await arr.setitem(slice(5), 1)
-        >>> await arr.nshards_initialized()
+        >>> await arr._nshards_initialized()
         3
         """
         return len(await _shards_initialized(self))
@@ -2469,8 +2467,6 @@ def nchunks_initialized(self) -> int:
         >>> arr.nchunks_initialized
         0
         >>> arr[:5] = 1
-        >>> arr.nshards_initialized
-        3
         >>> arr.nchunks_initialized
         6
         """
@@ -2490,10 +2486,10 @@ def _nshards_initialized(self) -> int:
         Examples
         --------
         >>> arr = await zarr.create(shape=(10,), chunks=(2,))
-        >>> arr.nshards_initialized
+        >>> arr._nshards_initialized
         0
         >>> arr[:5] = 1
-        >>> arr.nshard_initialized
+        >>> arr._nshard_initialized
         3
         """
         return sync(self._async_array._nshards_initialized())