Deprecate unused functions in _path

oscargus · oscargus · commit c9e1350893f1 · 2023-04-26T12:45:34.000+02:00
diff --git a/src/_path_wrapper.cpp b/src/_path_wrapper.cpp
@@ -93,10 +93,19 @@ static PyObject *Py_points_in_path(PyObject *self, PyObject *args)
 
 const char *Py_point_on_path__doc__ =
     "point_on_path(x, y, radius, path, trans)\n"
-    "--\n\n";
+    "--\n\n"
+    ".. deprecated:: 3.8\n";
 
 static PyObject *Py_point_on_path(PyObject *self, PyObject *args)
 {
+    char const* msg =
+        "_path.point_on_path is deprecated since Matplotlib 3.8 and will be removed "
+        "two minor releases later as it is not used in the library. If you rely on "
+        "it, please let us know.";
+    if (PyErr_WarnEx(PyExc_DeprecationWarning, msg, 1)) {
+        return NULL;
+    }
+
     double x, y, r;
     py::PathIterator path;
     agg::trans_affine trans;
@@ -125,10 +134,19 @@ static PyObject *Py_point_on_path(PyObject *self, PyObject *args)
 
 const char *Py_points_on_path__doc__ =
     "points_on_path(points, radius, path, trans)\n"
-    "--\n\n";
+    "--\n\n"
+    ".. deprecated:: 3.8\n";
 
 static PyObject *Py_points_on_path(PyObject *self, PyObject *args)
 {
+    char const* msg =
+        "_path.points_on_path is deprecated since Matplotlib 3.8 and will be removed "
+        "two minor releases later as it is not used in the library. If you rely on "
+        "it, please let us know.";
+    if (PyErr_WarnEx(PyExc_DeprecationWarning, msg, 1)) {
+        return NULL;
+    }
+
     numpy::array_view<const double, 2> points;
     double r;
     py::PathIterator path;
@@ -156,10 +174,19 @@ static PyObject *Py_points_on_path(PyObject *self, PyObject *args)
 
 const char *Py_get_path_extents__doc__ =
     "get_path_extents(path, trans)\n"
-    "--\n\n";
+    "--\n\n"
+    ".. deprecated:: 3.8\n";
 
 static PyObject *Py_get_path_extents(PyObject *self, PyObject *args)
 {
+    char const* msg =
+        "_path.get_path_extents is deprecated since Matplotlib 3.8 and will be "
+        "removed two minor releases later as it is not used in the library. If you "
+        "rely on it, please let us know.";
+    if (PyErr_WarnEx(PyExc_DeprecationWarning, msg, 1)) {
+        return NULL;
+    }
+
     py::PathIterator path;
     agg::trans_affine trans;
 
