[3.12] gh-101944: Clarify PyModule_AddObjectRef() documentation (GH-129433) (#129613)

miss-islington · vstinner · web-flow · commit a7645468c2ef · 2025-02-03T12:02:31.000Z
gh-101944: Clarify PyModule_AddObjectRef() documentation (GH-129433) (cherry picked from commit 04264a2) Co-authored-by: Victor Stinner <vstinner@python.org>
diff --git a/Doc/c-api/module.rst b/Doc/c-api/module.rst
@@ -496,9 +496,6 @@ state:
 
    On success, return ``0``. On error, raise an exception and return ``-1``.
 
-   Return ``-1`` if *value* is ``NULL``. It must be called with an exception
-   raised in this case.
-
    Example usage::
 
        static int
@@ -513,6 +510,10 @@ state:
            return res;
         }
 
+   To be convenient, the function accepts ``NULL`` *value* with an exception
+   set. In this case, return ``-1`` and just leave the raised exception
+   unchanged.
+
    The example can also be written without checking explicitly if *obj* is
    ``NULL``::
 
