Skip to content

Commit 9c8a087

Browse files
committed
Improve zarr.convenience deprecation
1 parent 714ad6a commit 9c8a087

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

src/zarr/convenience.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
"""
2+
Convenience helpers.
3+
4+
.. warning::
5+
6+
This sub-module is deprecated. All functions here are defined
7+
in the top level zarr namespace instead.
8+
"""
9+
110
import warnings
211

312
from zarr.api.synchronous import (
@@ -29,7 +38,8 @@
2938
]
3039

3140
warnings.warn(
32-
"zarr.convenience is deprecated, use zarr.api.synchronous",
41+
"zarr.convenience is deprecated. "
42+
"Import these functions from the top level zarr. namespace instead.",
3343
DeprecationWarning,
3444
stacklevel=2,
3545
)

0 commit comments

Comments
 (0)