summaryrefslogtreecommitdiffstats
path: root/Doc/c-api
diff options
context:
space:
mode:
authorIrit Katriel <1055913+iritkatriel@users.noreply.github.com>2023-12-31 23:16:33 (GMT)
committerGitHub <noreply@github.com>2023-12-31 23:16:33 (GMT)
commit2849cbb53afc8c6a4465f1b3490c67c2455caf6f (patch)
tree57528c3b21050c8c540da78aa0b96f98cd2025ca /Doc/c-api
parent30a6d79fb8bc1ef96600c290c016720103b74b2d (diff)
downloadcpython-2849cbb53afc8c6a4465f1b3490c67c2455caf6f.zip
cpython-2849cbb53afc8c6a4465f1b3490c67c2455caf6f.tar.gz
cpython-2849cbb53afc8c6a4465f1b3490c67c2455caf6f.tar.bz2
gh-101578: [doc] mention that PyErr_GetRaisedException returns NULL when the error indicator is not set (#113369)
Diffstat (limited to 'Doc/c-api')
-rw-r--r--Doc/c-api/exceptions.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst
index 284a9c7..c7e3cd9 100644
--- a/Doc/c-api/exceptions.rst
+++ b/Doc/c-api/exceptions.rst
@@ -440,7 +440,7 @@ Querying the error indicator
.. c:function:: PyObject *PyErr_GetRaisedException(void)
Return the exception currently being raised, clearing the error indicator at
- the same time.
+ the same time. Return ``NULL`` if the error indicator is not set.
This function is used by code that needs to catch exceptions,
or code that needs to save and restore the error indicator temporarily.