DOC: Document deprecation of C-API functions

These functions are believed to be unused, or at least largely unused.
rgerkin · Feb 1, 2020 · 5ee5012 · 5ee5012
1 parent 468ccdd
commit 5ee5012
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/doc/release/upcoming_changes/15427.deprecation.rst b/doc/release/upcoming_changes/15427.deprecation.rst
@@ -0,0 +1,12 @@
+Deprecation of probably unused C-API functions
+----------------------------------------------
+The following C-API functions are probably unused and have been
+deprecated:
+
+* ``PyArray_GetArrayParamsFromObject``
+* ``PyUFunc_GenericFunction``
+* ``PyUFunc_SetUsesArraysAsData``
+
+In most cases ``PyArray_GetArrayParamsFromObject`` should be replaced
+by converting to an array, while ``PyUFunc_GenericFunction`` can be
+replaced with ``PyObject_Call`` (see documentation for details).