Discrepancy in docs for PyModule_AddObjectRef

[tomasr8]

Bug report

Bug description:

The docs for PyModule_AddObjectRef say:

cpython/Doc/c-api/module.rst

Lines 520 to 521 in cae1526

	Return ``NULL`` if *value* is ``NULL``. It must be called with an exception
	raised in this case.

However the function actually returns -1 in that case:

cpython/Python/modsupport.c

Lines 590 to 597 in cae1526

	if (!value) {
	if (!PyErr_Occurred()) {
	PyErr_SetString(PyExc_SystemError,
	"PyModule_AddObjectRef() must be called "
	"with an exception raised if value is NULL");
	}
	return -1;
	}

We should update the documentation to reflect that.

CPython versions tested on:

CPython main branch

Operating systems tested on:

Linux

Linked PRs

• gh-121749: Fix discrepancy in docs for PyModule_AddObjectRef #121750
• [3.13] gh-121749: Fix discrepancy in docs for PyModule_AddObjectRef (GH-121750) #121752
• [3.12] gh-121749: Fix discrepancy in docs for PyModule_AddObjectRef (GH-121750) #121753

[GovernmentPlates]

On it

[encukou]

Thank you @tomasr8 for the report and @GovernmentPlates for the fix!