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

[Christian Heimes]

https://github.com/python/cpython/commit/937fb55d35373fd2701078251840b6be0465a6e1
commit: 937fb55d35373fd2701078251840b6be0465a6e1
branch: master
author: Andrés Delfino <adelfino at gmail.com>
committer: Christian Heimes <christian at python.org>
date: 2018-07-28T11:01:24+01:00
summary:

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

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

files:
M Doc/library/profile.rst

diff --git a/Doc/library/profile.rst b/Doc/library/profile.rst
index 5e33efe1c165..1a772fb7f941 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