[Python-checkins] [3.6] bpo-5978: Document that profiling needs cmd/function to return (GH-8515)

[Steve Dower]

https://github.com/python/cpython/commit/0041d721a6f6b312ef762838d390fc4d64cf5e3a
commit: 0041d721a6f6b312ef762838d390fc4d64cf5e3a
branch: 3.6
author: Andrés Delfino <adelfino at gmail.com>
committer: Steve Dower <steve.dower at microsoft.com>
date: 2018-07-28T13:24:35+01:00
summary:

[3.6] bpo-5978: Document that profiling needs cmd/function to return (GH-8515)

<!-- issue-number: bpo-5978 -->
https://bugs.python.org/issue5978
<!-- /issue-number -->
(cherry picked from commit 937fb55d35373fd2701078251840b6be0465a6e1)

Co-authored-by: Andrés Delfino <adelfino at gmail.com>

files:
M Doc/library/profile.rst

diff --git a/Doc/library/profile.rst b/Doc/library/profile.rst
index 32d2116e4b14..845065e38133 100644
--- a/Doc/library/profile.rst
+++ b/Doc/library/profile.rst
@@ -290,6 +290,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