Skip to content

Commit 179f2ff

Browse files
Fix minor documentation issues (zarr-developers#4120)
Assisted-by: GitHub Copilot (GPT-5.3-Codex)
1 parent 5236a03 commit 179f2ff

5 files changed

Lines changed: 8 additions & 8 deletions

File tree

docs/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ Zarr developers should make changes as smooth as possible for users. This means
396396

397397
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.
398398

399-
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.
399+
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.
400400

401401

402402
## Experimental API policy

docs/release-notes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -536,18 +536,18 @@ a `ManagedMemoryStore` is used. ([#3944](https://github.com/zarr-developers/zarr
536536
- Test `getsize()` and `getsize_prefix()` in `StoreTests`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693))
537537
- Test that a `ValueError` is raised for invalid byte range syntax in `StoreTests`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693))
538538
- Separate instantiating and opening a store in `StoreTests`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693))
539-
- Add a test for using Stores as a context managers in `StoreTests`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693))
539+
- Add a test for using Stores as context managers in `StoreTests`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693))
540540
- Implemented `LoggingStore.open()`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693))
541541
- `LoggingStore` is now a generic class. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693))
542542
- Change StoreTest's `test_store_repr`, `test_store_supports_writes`,
543543
`test_store_supports_partial_writes`, and `test_store_supports_listing`
544-
to to be implemented using `@abstractmethod`, rather raising `NotImplementedError`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693))
544+
to be implemented using `@abstractmethod`, rather than raising `NotImplementedError`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693))
545545
- Test the error raised for invalid buffer arguments in `StoreTests`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693))
546546
- 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))
547547
- Adds a new function `init_array` for initializing an array in storage, and refactors `create_array`
548548
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`.
549549
If `data` is given to `create_array`, then the `dtype` and `shape` attributes of `data` are used to define the
550-
corresponding attributes of the resulting Zarr array. Additionally, if `data` given and `write_data` is `True`,
550+
corresponding attributes of the resulting Zarr array. Additionally, if `data` is given and `write_data` is `True`,
551551
then the values in `data` will be written to the newly created array. ([#2761](https://github.com/zarr-developers/zarr-python/issues/2761))
552552

553553
### Bugfixes
@@ -559,7 +559,7 @@ a `ManagedMemoryStore` is used. ([#3944](https://github.com/zarr-developers/zarr
559559
- Use stdout rather than stderr as the default stream for `LoggingStore`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693))
560560
- Match the errors raised by read only stores in `StoreTests`. ([#2693](https://github.com/zarr-developers/zarr-python/issues/2693))
561561
- Fixed `ZipStore` to make sure the correct attributes are saved when instances are pickled.
562-
This fixes a previous bug that prevent using `ZipStore` with a `ProcessPoolExecutor`. ([#2762](https://github.com/zarr-developers/zarr-python/issues/2762))
562+
This fixes a previous bug that prevented using `ZipStore` with a `ProcessPoolExecutor`. ([#2762](https://github.com/zarr-developers/zarr-python/issues/2762))
563563
- Updated the optional test dependencies to include `botocore` and `fsspec`. ([#2768](https://github.com/zarr-developers/zarr-python/issues/2768))
564564
- Fixed the fsspec tests to skip if `botocore` is not installed.
565565
Previously they would have failed with an import error. ([#2768](https://github.com/zarr-developers/zarr-python/issues/2768))

src/zarr/core/dtype/npy/bytes.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1069,7 +1069,7 @@ def _from_json_v2(cls, data: DTypeJSON) -> Self:
10691069
Raises
10701070
------
10711071
DataTypeValidationError
1072-
If the input data is not a valid representation of this class class.
1072+
If the input data is not a valid representation of this class.
10731073
"""
10741074

10751075
if cls._check_json_v2(data):

src/zarr/core/group.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3065,7 +3065,7 @@ async def create_nodes(
30653065
"""
30663066

30673067
# Note: the only way to alter this value is via the config. If that's undesirable for some reason,
3068-
# then we should consider adding a keyword argument this this function
3068+
# then we should consider adding a keyword argument to this function
30693069
semaphore = asyncio.Semaphore(config.get("async.concurrency"))
30703070
create_tasks: list[Coroutine[None, None, str]] = []
30713071

tests/test_array.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1684,7 +1684,7 @@ def test_default_endianness(
16841684
store: Store, zarr_format: ZarrFormat, endianness: EndiannessStr
16851685
) -> None:
16861686
"""
1687-
Test that that endianness is correctly set when creating an array when not specifying a serializer
1687+
Test that endianness is correctly set when creating an array when not specifying a serializer.
16881688
"""
16891689
dtype = Int16(endianness=endianness)
16901690
arr = zarr.create_array(store=store, shape=(1,), dtype=dtype, zarr_format=zarr_format)

0 commit comments

Comments
 (0)