Deprecate the ScipyGridder class (#393)

It is replaced by `KNeighbors`, `Linear`, and `Cubic`. Remove the gallery example since we don't want people using this particular class.
fatiando · Nov 16, 2022 · 687e1ac · 687e1ac
1 parent a42126b
commit 687e1ac
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 93 deletions.
diff --git a/doc/gallery_src/scipygridder.py b/doc/gallery_src/scipygridder.py
diff --git a/verde/scipygridder.py b/verde/scipygridder.py
@@ -190,6 +190,12 @@ class ScipyGridder(_BaseScipyGridder):
     """
     A scipy.interpolate based gridder for scalar Cartesian data.
 
+    .. warning::
+
+        The ``ScipyGridder`` class is **deprecated** and will be **removed in
+        Verde v2.0.0**. Use :class:`~verde.KNeighbors`, :class:`~verde.Linear`,
+        and :class:`~verde.Cubic` instead.
+
     Provides a verde gridder interface to the scipy interpolators
     :class:`scipy.interpolate.LinearNDInterpolator`,
     :class:`scipy.interpolate.NearestNDInterpolator`, and
@@ -221,6 +227,11 @@ def __init__(self, method="cubic", extra_args=None):
         super().__init__()
         self.method = method
         self.extra_args = extra_args
+        warn(
+            "verde.ScipyGridder is deprecated and will be removed in Verde "
+            "v2.0.0. Use the KNeighbors, Linear, and Cubic classes instead.",
+            FutureWarning,
+        )
 
     def _get_interpolator(self):
         """