[3.14] gh-141004: Document `PyCode_Optimize` (GH-141378) (GH-141514)

gh-141004: Document `PyCode_Optimize` (GH-141378)
(cherry picked from commit d7862e9b1bd8f82e41c4f2c4dad31e15707d856f)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>

diff --git a/Doc/c-api/code.rst b/Doc/c-api/code.rst
index c9741b61254b1908a8151d04789d3aa84f60bea2..45f5e83adc48c62dd25ec6b02017974f06e23a1b 100644 (file)
--- a/Doc/c-api/code.rst
+++ b/Doc/c-api/code.rst
@@ -211,6 +211,17 @@ bound into a function.
    .. versionadded:: 3.12
 
 
+.. c:function:: PyObject *PyCode_Optimize(PyObject *code, PyObject *consts, PyObject *names, PyObject *lnotab_obj)
+
+   This is a :term:`soft deprecated` function that does nothing.
+
+   Prior to Python 3.10, this function would perform basic optimizations to a
+   code object.
+
+   .. versionchanged:: 3.10
+      This function now does nothing.
+
+
 .. _c_codeobject_flags:
 
 Code Object Flags