summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorHugo van Kemenade <hugovk@users.noreply.github.com>2022-01-14 17:25:36 (GMT)
committerGitHub <noreply@github.com>2022-01-14 17:25:36 (GMT)
commit73140de97cbeb01bb6c9af1da89ecb9355921e91 (patch)
treeff06fbc4b95be78cd2dcd19bf3d38f0b839e7074 /Doc
parent71c0b859ae16ee748cbb050a1f4de93c04e04f83 (diff)
downloadcpython-73140de97cbeb01bb6c9af1da89ecb9355921e91.zip
cpython-73140de97cbeb01bb6c9af1da89ecb9355921e91.tar.gz
cpython-73140de97cbeb01bb6c9af1da89ecb9355921e91.tar.bz2
bpo-23183: Document the timeit output (GH-30359)
Co-authored-by: Robert Collins <robertc@robertcollins.net>
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/timeit.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/Doc/library/timeit.rst b/Doc/library/timeit.rst
index 7f1c41d..660a546 100644
--- a/Doc/library/timeit.rst
+++ b/Doc/library/timeit.rst
@@ -282,6 +282,13 @@ It is possible to provide a setup statement that is executed only once at the be
$ python -m timeit -s 'text = "sample string"; char = "g"' 'text.find(char)'
1000000 loops, best of 5: 0.342 usec per loop
+In the output, there are three fields. The loop count, which tells you how many
+times the statement body was run per timing loop repetition. The repetition
+count ('best of 5') which tells you how many times the timing loop was
+repeated, and finally the time the statement body took on average within the
+best repetition of the timing loop. That is, the time the fastest repetition
+took divided by the loop count.
+
::
>>> import timeit