Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gh-101944: Clarify PyModule_AddObjectRef() documentation #129433

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −3
Open

gh-101944: Clarify PyModule_AddObjectRef() documentation #129433

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions Doc/c-api/module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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``::

Expand Down
Loading