diff options
author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2024-03-05 16:16:50 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-03-05 16:16:50 (GMT) |
commit | 6e89141d73eb89f2d7c827555f0e1cdf5c86be31 (patch) | |
tree | f178d2f27452a9f7315c719e206896625ed0a386 /Doc/c-api | |
parent | 0f5cd44e1cdffa0b373e853943d50e721279754d (diff) | |
download | cpython-6e89141d73eb89f2d7c827555f0e1cdf5c86be31.zip cpython-6e89141d73eb89f2d7c827555f0e1cdf5c86be31.tar.gz cpython-6e89141d73eb89f2d7c827555f0e1cdf5c86be31.tar.bz2 |
[3.12] Fix the PyGetSetDef documentation (GH-116056) (GH-116363)
closure is not a function pointer, it is a user data pointer.
(cherry picked from commit df594011089a83d151ac7000954665536f3461b5)
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Diffstat (limited to 'Doc/c-api')
-rw-r--r-- | Doc/c-api/structures.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Doc/c-api/structures.rst b/Doc/c-api/structures.rst index 77f2b69..36a0abc 100644 --- a/Doc/c-api/structures.rst +++ b/Doc/c-api/structures.rst @@ -702,12 +702,12 @@ Defining Getters and Setters .. c:member:: void* closure - Optional function pointer, providing additional data for getter and setter. + Optional user data pointer, providing additional data for getter and setter. .. c:type:: PyObject *(*getter)(PyObject *, void *) The ``get`` function takes one :c:expr:`PyObject*` parameter (the - instance) and a function pointer (the associated ``closure``): + instance) and a user data pointer (the associated ``closure``): It should return a new reference on success or ``NULL`` with a set exception on failure. @@ -715,7 +715,7 @@ Defining Getters and Setters .. c:type:: int (*setter)(PyObject *, PyObject *, void *) ``set`` functions take two :c:expr:`PyObject*` parameters (the instance and - the value to be set) and a function pointer (the associated ``closure``): + the value to be set) and a user data pointer (the associated ``closure``): In case the attribute should be deleted the second parameter is ``NULL``. Should return ``0`` on success or ``-1`` with a set exception on failure. |