Improve deprecation of zarr.creation and zarr.convenience (zarr-developers#2609)

dstansby · web-flow · commit 79078522b605 · 2025-01-02T18:53:17.000Z
diff --git a/src/zarr/convenience.py b/src/zarr/convenience.py
@@ -1,3 +1,12 @@
+"""
+Convenience helpers.
+
+.. warning::
+
+    This sub-module is deprecated. All functions here are defined
+    in the top level zarr namespace instead.
+"""
+
 import warnings
 
 from zarr.api.synchronous import (
@@ -29,7 +38,8 @@
 ]
 
 warnings.warn(
-    "zarr.convenience is deprecated, use zarr.api.synchronous",
+    "zarr.convenience is deprecated. "
+    "Import these functions from the top level zarr. namespace instead.",
     DeprecationWarning,
     stacklevel=2,
 )
diff --git a/src/zarr/creation.py b/src/zarr/creation.py
@@ -1,3 +1,12 @@
+"""
+Helpers for creating arrays.
+
+.. warning::
+
+    This sub-module is deprecated. All functions here are defined
+    in the top level zarr namespace instead.
+"""
+
 import warnings
 
 from zarr.api.synchronous import (
@@ -31,7 +40,8 @@
 ]
 
 warnings.warn(
-    "zarr.creation is deprecated, use zarr.api.synchronous",
+    "zarr.creation is deprecated. "
+    "Import these functions from the top level zarr. namespace instead.",
     DeprecationWarning,
     stacklevel=2,
 )
