From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Sun, 31 Dec 2023 23:22:55 +0000 (+0100)
Subject: [3.12] gh-101578: [doc] mention that PyErr_GetRaisedException returns NULL when the... 
X-Git-Tag: v3.12.2~237
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f3d3663a47f82de5ddf384ea1497bd3b36d795d7;p=thirdparty%2FPython%2Fcpython.git

[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>
---

diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst
index d5119789a5f6..39408641c8a5 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.