From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Sun, 28 Jan 2018 15:33:23 +0000 (-0800)
Subject: Fix PyTrace_RETURN documentation (GH-5384) (GH-5386)
X-Git-Tag: v3.6.5rc1~131
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=33febfb03998598a35f97b4ef66d33a2d43716cd;p=python

Fix PyTrace_RETURN documentation (GH-5384) (GH-5386)

It will be triggered when propagating an exception.
(cherry picked from commit 79db11ce99332d62917be9d03b31494b1ff2f96a)
---

diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst
index bc92c3e16b..c8d429de51 100644
--- a/Doc/c-api/init.rst
+++ b/Doc/c-api/init.rst
@@ -1110,7 +1110,7 @@ Python-level trace functions in previous versions.
 .. c:var:: int PyTrace_RETURN
 
    The value for the *what* parameter to :c:type:`Py_tracefunc` functions when a
-   call is returning without propagating an exception.
+   call is about to return.
 
 
 .. c:var:: int PyTrace_C_CALL