summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDominic H <dom@dominic.sk>2024-07-14 10:11:10 (GMT)
committerGitHub <noreply@github.com>2024-07-14 10:11:10 (GMT)
commit26dfb2771236bfd96cdaa1081103f75141ecff47 (patch)
tree79a7e7456678dc4849ed4dc91fc3b9e67ed946f6
parentcae15267166e217822e3c58ac22b7817162f323a (diff)
downloadcpython-26dfb2771236bfd96cdaa1081103f75141ecff47.zip
cpython-26dfb2771236bfd96cdaa1081103f75141ecff47.tar.gz
cpython-26dfb2771236bfd96cdaa1081103f75141ecff47.tar.bz2
gh-121749: Fix discrepancy in docs for `PyModule_AddObjectRef` (GH-121750)
-rw-r--r--Doc/c-api/module.rst2
-rw-r--r--Misc/NEWS.d/next/Documentation/2024-07-14-11-48-10.gh-issue-121749.nxHoTk.rst1
2 files changed, 2 insertions, 1 deletions
diff --git a/Doc/c-api/module.rst b/Doc/c-api/module.rst
index ce9d5a0..3ea7aeb 100644
--- a/Doc/c-api/module.rst
+++ b/Doc/c-api/module.rst
@@ -517,7 +517,7 @@ state:
On success, return ``0``. On error, raise an exception and return ``-1``.
- Return ``NULL`` if *value* is ``NULL``. It must be called with an exception
+ Return ``-1`` if *value* is ``NULL``. It must be called with an exception
raised in this case.
Example usage::
diff --git a/Misc/NEWS.d/next/Documentation/2024-07-14-11-48-10.gh-issue-121749.nxHoTk.rst b/Misc/NEWS.d/next/Documentation/2024-07-14-11-48-10.gh-issue-121749.nxHoTk.rst
new file mode 100644
index 0000000..17dc60c
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2024-07-14-11-48-10.gh-issue-121749.nxHoTk.rst
@@ -0,0 +1 @@
+Fix documentation for :c:func:`PyModule_AddObjectRef`.