From: Andrés Delfino <adelfino@gmail.com>
Date: Sat, 28 Jul 2018 10:01:24 +0000 (-0300)
Subject: bpo-5978: Document that profiling needs cmd/function to return (GH-7938)
X-Git-Tag: v3.8.0a1~1296
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=937fb55d35373fd2701078251840b6be0465a6e1;p=python

bpo-5978: Document that profiling needs cmd/function to return (GH-7938)

<!-- issue-number: bpo-5978 -->
https://bugs.python.org/issue5978
<!-- /issue-number -->
---

diff --git a/Doc/library/profile.rst b/Doc/library/profile.rst
index 5e33efe1c1..1a772fb7f9 100644
--- a/Doc/library/profile.rst
+++ b/Doc/library/profile.rst
@@ -310,6 +310,11 @@ functions:
 
       Profile ``func(*args, **kwargs)``
 
+Note that profiling will only work if the called command/function actually
+returns.  If the interpreter is terminated (e.g. via a :func:`sys.exit` call
+during the called command/function execution) no profiling results will be
+printed.
+
 .. _profile-stats:
 
 The :class:`Stats` Class