summaryrefslogtreecommitdiffstats
path: root/Doc/c-api
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2023-12-31 23:22:55 (GMT)
committerGitHub <noreply@github.com>2023-12-31 23:22:55 (GMT)
commitf3d3663a47f82de5ddf384ea1497bd3b36d795d7 (patch)
treec0131c9283b744484788fc2ba2699512870153cf /Doc/c-api
parenta8011d5eb0f2bc9f27d00f0db6090232976c0eac (diff)
downloadcpython-f3d3663a47f82de5ddf384ea1497bd3b36d795d7.zip
cpython-f3d3663a47f82de5ddf384ea1497bd3b36d795d7.tar.gz
cpython-f3d3663a47f82de5ddf384ea1497bd3b36d795d7.tar.bz2
[3.12] gh-101578: [doc] mention that PyErr_GetRaisedException returns NULL when the error indicator is not set (GH-113369) (#113606)
gh-101578: [doc] mention that PyErr_GetRaisedException returns NULL when the error indicator is not set (GH-113369) (cherry picked from commit 2849cbb53afc8c6a4465f1b3490c67c2455caf6f) Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
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 d511978..3940864 100644
--- a/Doc/c-api/exceptions.rst
+++ b/Doc/c-api/exceptions.rst
@@ -427,7 +427,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.