https://github.com/python/cpython/commit/04264a286e5ddfe8ac7423f7376ca34a2ca8b7ba
commit: 04264a286e5ddfe8ac7423f7376ca34a2ca8b7ba
branch: main
author: Victor Stinner <[email protected]>
committer: vstinner <[email protected]>
date: 2025-02-03T12:55:22+01:00
summary:
gh-101944: Clarify PyModule_AddObjectRef() documentation (#129433)
files:
M Doc/c-api/module.rst
diff --git a/Doc/c-api/module.rst b/Doc/c-api/module.rst
index f82a050ab75de0..f71089370152ce 100644
--- a/Doc/c-api/module.rst
+++ b/Doc/c-api/module.rst
@@ -523,9 +523,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
@@ -540,6 +537,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``::
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
