From 53bc963c6b40a18c44569408a1399a8c71d6b7a0 Mon Sep 17 00:00:00 2001 From: Dimitri Papadopoulos <3234522+DimitriPapadopoulos@users.noreply.github.com> Date: Mon, 6 Jul 2026 09:12:17 +0200 Subject: [PATCH] Fix minor documentation issues Assisted-by: GitHub Copilot (GPT-5.3-Codex) --- docs/contributing.md | 2 +- docs/release-notes.md | 8 ++++---- src/zarr/core/dtype/npy/bytes.py | 2 +- src/zarr/core/group.py | 2 +- tests/test_array.py | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index 750f7c7a65..084916d584 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -396,7 +396,7 @@ Zarr developers should make changes as smooth as possible for users. This means The Zarr library is an implementation of a file format standard defined externally -- see the [Zarr specifications website](https://zarr-specs.readthedocs.io) for the list of Zarr file format specifications. -If an existing Zarr format version changes, or a new version of the Zarr format is released, then the Zarr library will generally require changes. It is very likely that a new Zarr format will require extensive breaking changes to the Zarr library, and so support for a new Zarr format in the Zarr library will almost certainly come in new `major` release. When the Zarr library adds support for a new Zarr format, there may be a period of accelerated changes as developers refine newly added APIs and deprecate old APIs. In such a transitional phase breaking changes may be more frequent than usual. +If an existing Zarr format version changes, or a new version of the Zarr format is released, then the Zarr library will generally require changes. It is very likely that a new Zarr format will require extensive breaking changes to the Zarr library, and so support for a new Zarr format in the Zarr library will almost certainly come in a new `major` release. When the Zarr library adds support for a new Zarr format, there may be a period of accelerated changes as developers refine newly added APIs and deprecate old APIs. In such a transitional phase breaking changes may be more frequent than usual. ## Experimental API policy diff --git a/docs/release-notes.md b/docs/release-notes.md index 4511c9815e..93cf1e73b6 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -536,18 +536,18 @@ a `ManagedMemoryStore` is used. ([#3944](https://github.com/zarr-developers/zarr - Test `getsize()` and `getsize_prefix()` in `StoreTests`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693)) - Test that a `ValueError` is raised for invalid byte range syntax in `StoreTests`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693)) - Separate instantiating and opening a store in `StoreTests`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693)) -- Add a test for using Stores as a context managers in `StoreTests`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693)) +- Add a test for using Stores as context managers in `StoreTests`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693)) - Implemented `LoggingStore.open()`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693)) - `LoggingStore` is now a generic class. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693)) - Change StoreTest's `test_store_repr`, `test_store_supports_writes`, `test_store_supports_partial_writes`, and `test_store_supports_listing` - to to be implemented using `@abstractmethod`, rather raising `NotImplementedError`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693)) + to be implemented using `@abstractmethod`, rather than raising `NotImplementedError`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693)) - Test the error raised for invalid buffer arguments in `StoreTests`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693)) - Test that data can be written to a store that's not yet open using the store.set method in `StoreTests`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693)) - Adds a new function `init_array` for initializing an array in storage, and refactors `create_array` to use `init_array`. `create_array` takes two new parameters: `data`, an optional array-like object, and `write_data`, a bool which defaults to `True`. If `data` is given to `create_array`, then the `dtype` and `shape` attributes of `data` are used to define the - corresponding attributes of the resulting Zarr array. Additionally, if `data` given and `write_data` is `True`, + corresponding attributes of the resulting Zarr array. Additionally, if `data` is given and `write_data` is `True`, then the values in `data` will be written to the newly created array. ([#2761](https://github.com/zarr-developers/zarr-python/issues/2761)) ### Bugfixes @@ -559,7 +559,7 @@ a `ManagedMemoryStore` is used. ([#3944](https://github.com/zarr-developers/zarr - Use stdout rather than stderr as the default stream for `LoggingStore`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693)) - Match the errors raised by read only stores in `StoreTests`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693)) - Fixed `ZipStore` to make sure the correct attributes are saved when instances are pickled. - This fixes a previous bug that prevent using `ZipStore` with a `ProcessPoolExecutor`. ([#2762](https://github.com/zarr-developers/zarr-python/issues/2762)) + This fixes a previous bug that prevented using `ZipStore` with a `ProcessPoolExecutor`. ([#2762](https://github.com/zarr-developers/zarr-python/issues/2762)) - Updated the optional test dependencies to include `botocore` and `fsspec`. ([#2768](https://github.com/zarr-developers/zarr-python/issues/2768)) - Fixed the fsspec tests to skip if `botocore` is not installed. Previously they would have failed with an import error. ([#2768](https://github.com/zarr-developers/zarr-python/issues/2768)) diff --git a/src/zarr/core/dtype/npy/bytes.py b/src/zarr/core/dtype/npy/bytes.py index af8fa7a272..e60f3c6c48 100644 --- a/src/zarr/core/dtype/npy/bytes.py +++ b/src/zarr/core/dtype/npy/bytes.py @@ -1069,7 +1069,7 @@ def _from_json_v2(cls, data: DTypeJSON) -> Self: Raises ------ DataTypeValidationError - If the input data is not a valid representation of this class class. + If the input data is not a valid representation of this class. """ if cls._check_json_v2(data): diff --git a/src/zarr/core/group.py b/src/zarr/core/group.py index 52eaa3e144..0aaf89234e 100644 --- a/src/zarr/core/group.py +++ b/src/zarr/core/group.py @@ -3065,7 +3065,7 @@ async def create_nodes( """ # Note: the only way to alter this value is via the config. If that's undesirable for some reason, - # then we should consider adding a keyword argument this this function + # then we should consider adding a keyword argument to this function semaphore = asyncio.Semaphore(config.get("async.concurrency")) create_tasks: list[Coroutine[None, None, str]] = [] diff --git a/tests/test_array.py b/tests/test_array.py index 0d6d2d5906..89d7547e78 100644 --- a/tests/test_array.py +++ b/tests/test_array.py @@ -1684,7 +1684,7 @@ def test_default_endianness( store: Store, zarr_format: ZarrFormat, endianness: EndiannessStr ) -> None: """ - Test that that endianness is correctly set when creating an array when not specifying a serializer + Test that endianness is correctly set when creating an array when not specifying a serializer. """ dtype = Int16(endianness=endianness) arr = zarr.create_array(store=store, shape=(1,), dtype=dtype, zarr_format=zarr_format)