Skip to content

Commit 0081fef

Browse files
nuglifeleojiLeo Jid-v-b
authored
DOC: document init_group removal in v3 migration guide (#3851)
Closes #2720 Made-with: Cursor Co-authored-by: Leo Ji <nuglifeleoji@gmail.com> Co-authored-by: Davis Bennett <davis.v.bennett@gmail.com>
1 parent ac83402 commit 0081fef

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

changes/2720.doc.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Document removal of `zarr.storage.init_group` in v3 migration guide, with replacement using `zarr.open_group`/`zarr.create_group`.

docs/user-guide/v3_migration.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,15 @@ The following sections provide details on breaking changes in Zarr-Python 3.
114114
- Use [`zarr.Group.require_array`][] in place of `zarr.Group.require_dataset`
115115
3. Disallow "." syntax for getting group members. To get a member of a group named `foo`,
116116
use `group["foo"]` in place of `group.foo`.
117+
4. The `zarr.storage.init_group` low-level helper function has been removed. Use
118+
[`zarr.open_group`][] or [`zarr.create_group`][] instead:
119+
120+
```diff
121+
- from zarr.storage import init_group
122+
- init_group(store, overwrite=True, path="my/path")
123+
+ import zarr
124+
+ zarr.open_group(store, mode="w", path="my/path")
125+
```
117126

118127
### The Store class
119128

0 commit comments

Comments
 (0)