[Python-checkins] Document the surprising sideeffect PyErr_Print(). (GH-12081) (GH-12084)

Wed Feb 27 18:46:11 EST 2019

https://github.com/python/cpython/commit/fb352413c1fac65823f274feeb369cd5ab1af2e4
commit: fb352413c1fac65823f274feeb369cd5ab1af2e4
branch: 3.6
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: Ned Deily <nad at python.org>
date: 2019年02月27日T18:46:08-05:00
summary:
Document the surprising sideeffect PyErr_Print(). (GH-12081) (GH-12084)
(cherry picked from commit 4173772031747a9b249be4100b4aa9eda805ea23)
Co-authored-by: Gregory P. Smith <greg at krypto.org>
files:
M Doc/c-api/exceptions.rst

diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst
index 2bc1bd876a2f..817469af0a58 100644
--- a/Doc/c-api/exceptions.rst
+++ b/Doc/c-api/exceptions.rst
@@ -53,8 +53,12 @@ Printing and clearing
 .. c:function:: void PyErr_PrintEx(int set_sys_last_vars)
 
 Print a standard traceback to ``sys.stderr`` and clear the error indicator.
- Call this function only when the error indicator is set. (Otherwise it will
- cause a fatal error!)
+ **Unless** the error is a ``SystemExit``. In that case the no traceback
+ is printed and Python process will exit with the error code specified by
+ the ``SystemExit`` instance.
+
+ Call this function **only** when the error indicator is set. Otherwise it
+ will cause a fatal error!
 
 If *set_sys_last_vars* is nonzero, the variables :data:`sys.last_type`,
 :data:`sys.last_value` and :data:`sys.last_traceback` will be set to the
