From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Thu, 13 Nov 2025 15:14:32 +0000 (+0100)
Subject: [3.13] gh-141004: Document `PyCode_Optimize` (GH-141378) (GH-141515)
X-Git-Tag: v3.13.10~86
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c86f5d3ebe6c0b343cd270fb55f9cd118d3df110;p=thirdparty%2FPython%2Fcpython.git

[3.13] gh-141004: Document `PyCode_Optimize` (GH-141378) (GH-141515)

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 f38dd8060fcf..32974fa48255 100644
--- 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