]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.12] gh-115653: Document PyCode_GetFirstFree() (GH-115654) (#115752)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Wed, 21 Feb 2024 10:31:56 +0000 (11:31 +0100)
committerGitHub <noreply@github.com>
Wed, 21 Feb 2024 10:31:56 +0000 (11:31 +0100)
gh-115653: Document PyCode_GetFirstFree() (GH-115654)

Correct the return type of the PyCode_GetNumFree() documentation.
(cherry picked from commit 10fc4675fdb14e19f2fdd15102c6533b9f71e992)

Co-authored-by: Bogdan Romanyuk <65823030+wrongnull@users.noreply.github.com>
Doc/c-api/code.rst

index 382cfbff864072c60cfc29dd2a30b979d04d1b2a..f6fdd7574323c7ef6ee15388a0818faebf0a8a08 100644 (file)
@@ -30,9 +30,13 @@ bound into a function.
    Return true if *co* is a :ref:`code object <code-objects>`.
    This function always succeeds.
 
-.. c:function:: int PyCode_GetNumFree(PyCodeObject *co)
+.. c:function:: Py_ssize_t PyCode_GetNumFree(PyCodeObject *co)
 
-   Return the number of free variables in *co*.
+   Return the number of free variables in a code object.
+
+.. c:function:: int PyCode_GetFirstFree(PyCodeObject *co)
+
+   Return the position of the first free variable in a code object.
 
 .. c:function:: PyCodeObject* PyUnstable_Code_New(int argcount, int kwonlyargcount, int nlocals, int stacksize, int flags, PyObject *code, PyObject *consts, PyObject *names, PyObject *varnames, PyObject *freevars, PyObject *cellvars, PyObject *filename, PyObject *name, PyObject *qualname, int firstlineno, PyObject *linetable, PyObject *exceptiontable)