Minor doc tweaks from review

python · pablogsal · Mar 14, 2023 · Feb 8, 2023 · Feb 18, 2023 · Feb 18, 2023
commit 295f7dd77e83e04617f7183e2e83d821b4526419
@@ -238,13 +238,13 @@ the garbage collector.
 
 .. c:function:: void PyUnstable_GC_VisitObjects(gcvisitobjects_t callback, void *arg)
 
-   Run supplied callback on all live GC-capable objects.
+   Run supplied *callback* on all live GC-capable objects. *arg* is passed through to
+   all invocations of *callback*.
 
    .. warning::
       If new objects are (de)allocated by the callback it is undefined if they
       will be visited.
 
-   .. warning::
       Garbage collection is disabled during operation. Explicitly running a collection
       in the callback may lead to undefined behaviour e.g. visiting the same objects
       multiple times or not at all.
@@ -254,9 +254,9 @@ the garbage collector.
 .. c:type:: int (*gcvisitobjects_t)(PyObject *object, void *arg)
 
    Type of the visitor function to be passed to :c:func:`PyUnstable_GC_VisitObjects`.
-   ``arg`` is the same as passed to ``PyUnstable_GC_VisitObjects``. Returning ``0``
-   allows iteration to continue, returning ``1`` stops further iteration. Returning any
-   other value has undefined behavior.
+   *arg* is the same as the *arg* passed to ``PyUnstable_GC_VisitObjects``.
+   Return ``0`` to continue iteration, return ``1`` to stop iteration. Other return
+   values are reserved for now so behavior on returning anything else is undefined.
 
    .. versionadded:: 3.12