From 1e5798e37255e921beae2aaa8329d5c48a2ef230 Mon Sep 17 00:00:00 2001 From: da-woods Date: Sat, 12 Apr 2025 16:36:02 +0100 Subject: [PATCH] Docs: Fix specifications of `gcvisitobjects_t` (#132433) `gcvisitobjects_t` callbacks should return 1 for the iteration to continue instead of 0. --- Doc/c-api/gcsupport.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/c-api/gcsupport.rst b/Doc/c-api/gcsupport.rst index 621da3eb0699..d1f0982b8189 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 -- 2.47.3