summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrés Delfino <adelfino@gmail.com>2018-07-28 10:01:24 (GMT)
committerChristian Heimes <christian@python.org>2018-07-28 10:01:24 (GMT)
commit937fb55d35373fd2701078251840b6be0465a6e1 (patch)
treee18e399a408605a5237022342884da7e41b16a95
parentb4bc5cab82e6855e4ebc33ba0b669ddffad30fb3 (diff)
downloadcpython-937fb55d35373fd2701078251840b6be0465a6e1.zip
cpython-937fb55d35373fd2701078251840b6be0465a6e1.tar.gz
cpython-937fb55d35373fd2701078251840b6be0465a6e1.tar.bz2
bpo-5978: Document that profiling needs cmd/function to return (GH-7938)
<!-- issue-number: bpo-5978 --> https://bugs.python.org/issue5978 <!-- /issue-number -->
-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 5e33efe..1a772fb 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