Skip to content

Commit 9391f43

Browse files
authored
chore: remove deprecated convenience and creation modules (#3900)
* chore: remove deprecated convenience and creation modules * docs: remove references to deprecated modules from docs * docs: changelog * docs: remove redirect to absent page
1 parent e6207b7 commit 9391f43

File tree

10 files changed

+5
-120
lines changed

10 files changed

+5
-120
lines changed

changes/3900.misc.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Remove deprecated `zarr.convenience` and `zarr.creation` modules.

docs/api/zarr/convenience.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/api/zarr/deprecated/convenience.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/api/zarr/deprecated/creation.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/api/zarr/index.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ Complete reference documentation for the Zarr-Python API.
2121

2222
- **[Load](load.md)** - Loading data from Zarr stores
2323
- **[Save](save.md)** - Saving data to Zarr format
24-
- **[Convenience](convenience.md)** - High-level convenience functions
2524

2625
### Data Types and Configuration
2726

@@ -55,13 +54,6 @@ The ABC module defines interfaces for extending Zarr:
5554
- **[Testing](testing/index.md)** - Utilities for testing Zarr-based code
5655

5756

58-
## Migration and Compatibility
59-
60-
- **[Deprecated Functions](deprecated/convenience.md)** - Legacy convenience functions
61-
- **[Deprecated Creation](deprecated/creation.md)** - Legacy array creation functions
62-
63-
These deprecated modules are maintained for backward compatibility but should be avoided in new code.
64-
6557
## Getting Help
6658

6759
- Check the [User Guide](../../user-guide/index.md) for tutorials and examples

mkdocs.yml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ nav:
4343
- api/zarr/codecs.md
4444
- api/zarr/codecs/numcodecs.md
4545
- api/zarr/config.md
46-
- api/zarr/convenience.md
4746
- api/zarr/errors.md
4847
- api/zarr/metadata.md
4948
- api/zarr/registry.md
@@ -72,9 +71,6 @@ nav:
7271
- api/zarr/testing/store.md
7372
- api/zarr/testing/strategies.md
7473
- api/zarr/testing/utils.md
75-
- deprecated:
76-
- Convenience sub-module: api/zarr/deprecated/convenience.md
77-
- Creation sub-module: api/zarr/deprecated/creation.md
7874
- release-notes.md
7975
- contributing.md
8076
watch:
@@ -221,7 +217,6 @@ plugins:
221217
'developers/contributing.html.md': 'contributing.md'
222218
'developers/index.html.md': 'contributing.md'
223219
'developers/roadmap.html.md': 'https://zarr.readthedocs.io/en/v3.0.8/developers/roadmap.html'
224-
'api/zarr/creation.md': 'api/zarr/deprecated/creation.md'
225220
'api.md': 'api/zarr/index.md'
226221
'api/zarr/metadata/migrate_v3.md': 'api/zarr/metadata.md'
227222

src/zarr/api/asynchronous.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -359,8 +359,8 @@ async def open(
359359
If using an fsspec URL to create the store, these will be passed to
360360
the backend implementation. Ignored otherwise.
361361
**kwargs
362-
Additional parameters are passed through to [`zarr.creation.open_array`][] or
363-
[`open_group`][zarr.api.asynchronous.open_group].
362+
Additional parameters are passed through to `zarr.open_array` or
363+
`zarr.open_group`.
364364
365365
Returns
366366
-------

src/zarr/api/synchronous.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -206,8 +206,8 @@ def open(
206206
If using an fsspec URL to create the store, these will be passed to
207207
the backend implementation. Ignored otherwise.
208208
**kwargs
209-
Additional parameters are passed through to [`zarr.creation.open_array`][] or
210-
[`open_group`][zarr.api.asynchronous.open_group].
209+
Additional parameters are passed through to `zarr.open_array` or
210+
`zarr.open_group`.
211211
212212
Returns
213213
-------

src/zarr/convenience.py

Lines changed: 0 additions & 44 deletions
This file was deleted.

src/zarr/creation.py

Lines changed: 0 additions & 47 deletions
This file was deleted.

0 commit comments

Comments
 (0)