From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> Date: Sun, 18 May 2025 16:34:19 +0000 (+0200) Subject: [3.14] document `Py_VISIT` as a macro in the docs (GH-133688) (#134186) X-Git-Tag: v3.14.0b2~122 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=76957eb8ccd98b4647bfc655d145aadd05c977e0;p=thirdparty%2FPython%2Fcpython.git [3.14] document `Py_VISIT` as a macro in the docs (GH-133688) (#134186) document `Py_VISIT` as a macro in the docs (GH-133688) (cherry picked from commit bb32f3c698f5192dddd2d2f33c7c0a3d05afc223) Co-authored-by: da-woods --- diff --git a/Doc/c-api/gcsupport.rst b/Doc/c-api/gcsupport.rst index d1f0982b8189..3e23605778f0 100644 --- a/Doc/c-api/gcsupport.rst +++ b/Doc/c-api/gcsupport.rst @@ -180,9 +180,9 @@ provided. In order to use this macro, the :c:member:`~PyTypeObject.tp_traverse` must name its arguments exactly *visit* and *arg*: -.. c:function:: void Py_VISIT(PyObject *o) +.. c:macro:: Py_VISIT(o) - If *o* is not ``NULL``, call the *visit* callback, with arguments *o* + If the :c:expr:`PyObject *` *o* is not ``NULL``, call the *visit* callback, with arguments *o* and *arg*. If *visit* returns a non-zero value, then return it. Using this macro, :c:member:`~PyTypeObject.tp_traverse` handlers look like::