summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorAndrés Delfino <adelfino@gmail.com>2018-07-28 12:24:35 (GMT)
committerSteve Dower <steve.dower@microsoft.com>2018-07-28 12:24:35 (GMT)
commit0041d721a6f6b312ef762838d390fc4d64cf5e3a (patch)
treefb36787705fbcccc359d4d5f36209cc41f9da2ee /Doc
parent9d85856044a2c7d681ea38b5ff99af375b228a0f (diff)
downloadcpython-0041d721a6f6b312ef762838d390fc4d64cf5e3a.zip
cpython-0041d721a6f6b312ef762838d390fc4d64cf5e3a.tar.gz
cpython-0041d721a6f6b312ef762838d390fc4d64cf5e3a.tar.bz2
[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@gmail.com>
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/profile.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/Doc/library/profile.rst b/Doc/library/profile.rst
index 32d2116..845065e 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