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

miss-islington · andresdelfino · web-flow · commit c6801b48a196 · 2018-07-28T05:23:42.000-07:00
https://bugs.python.org/issue5978  (cherry picked from commit 937fb55) Co-authored-by: Andrés Delfino <adelfino@gmail.com>
diff --git a/Doc/library/profile.rst b/Doc/library/profile.rst
@@ -297,6 +297,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
