https://github.com/python/cpython/commit/1e5798e37255e921beae2aaa8329d5c48a2ef230
commit: 1e5798e37255e921beae2aaa8329d5c48a2ef230
branch: main
author: da-woods <dw-...@d-woods.co.uk>
committer: picnixz <10796600+picn...@users.noreply.github.com>
date: 2025-04-12T17:36:02+02:00
summary:
Docs: Fix specifications of `gcvisitobjects_t` (#132433)
`gcvisitobjects_t` callbacks should return 1 for the iteration to continue
instead of 0.
files:
M Doc/c-api/gcsupport.rst
diff --git a/Doc/c-api/gcsupport.rst b/Doc/c-api/gcsupport.rst
index 621da3eb069949..d1f0982b818931 100644
--- a/Doc/c-api/gcsupport.rst
+++ b/Doc/c-api/gcsupport.rst
@@ -277,7 +277,7 @@ the garbage collector.
Type of the visitor function to be passed to
:c:func:`PyUnstable_GC_VisitObjects`.
*arg* is the same as the *arg* passed to ``PyUnstable_GC_VisitObjects``.
- Return ``0`` to continue iteration, return ``1`` to stop iteration. Other
return
+ Return ``1`` to continue iteration, return ``0`` to stop iteration. Other
return
values are reserved for now so behavior on returning anything else is
undefined.
.. versionadded:: 3.12
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: arch...@mail-archive.com
