added deprecation messages

euro-cordex · Dec 19, 2024 · 62732ee · 62732ee
1 parent 142aa50
commit 62732ee
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 1 deletion.
diff --git a/cordex/preprocessing/preprocessing.py b/cordex/preprocessing/preprocessing.py
@@ -269,6 +269,11 @@ def replace_rlon_rlat(ds, domain=None):
         Dataset with updated rlon, rlat.
 
     """
+    warn(
+        "replace_rlon_rlat is deprecated, please use rewrite_coords instead",
+        DeprecationWarning,
+        stacklevel=2,
+    )
     ds = ds.copy()
     if domain is None:
         domain = ds.cx.domain_id
@@ -297,6 +302,11 @@ def replace_vertices(ds, domain=None):
         Dataset with updated vertices.
 
     """
+    warn(
+        "replace_vertices is deprecated, please use rewrite_coords instead",
+        DeprecationWarning,
+        stacklevel=2,
+    )
     ds = ds.copy()
     if domain is None:
         domain = ds.attrs.get("CORDEX_domain", None)
@@ -325,6 +335,11 @@ def replace_lon_lat(ds, domain=None):
         Dataset with updated lon, lat.
 
     """
+    warn(
+        "replace_lon_lat is deprecated, please use rewrite_coords instead",
+        DeprecationWarning,
+        stacklevel=2,
+    )
     ds = ds.copy()
     if domain is None:
         domain = ds.cx.domain_id
@@ -355,6 +370,11 @@ def replace_coords(ds, domain=None):
 
 
     """
+    warn(
+        "replace_coords is deprecated, please use rewrite_coords instead",
+        DeprecationWarning,
+        stacklevel=2,
+    )
     ds = ds.copy()
     ds = replace_rlon_rlat(ds, domain)
     ds = replace_lon_lat(ds, domain)
@@ -380,6 +400,11 @@ def replace_grid(ds, domain=None):
 
 
     """
+    warn(
+        "replace_grid is deprecated, please use rewrite_coords instead",
+        DeprecationWarning,
+        stacklevel=2,
+    )
     ds = ds.copy()
     ds = replace_rlon_rlat(ds, domain)
     ds = replace_lon_lat(ds, domain)

diff --git a/docs/whats_new.rst b/docs/whats_new.rst
@@ -12,7 +12,7 @@ rounding errors. This version drops python3.8 support.
 New Features
 ~~~~~~~~~~~~
 
-- New function :py:meth:`cordex.rewrite_coords` (:pull:`306`).
+- New function :py:meth:`cordex.rewrite_coords` (:pull:`306`, :pull:`307`).
 
 Breaking Changes
 ~~~~~~~~~~~~~~~~