From: Andrew Kuchling <amk@amk.ca>
Date: Tue, 21 Apr 2015 23:43:33 +0000 (-0400)
Subject: #15183: clarify timeit documentation to say that setup statement isn't timed
X-Git-Tag: v3.5.0b1~311^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=333518e01df0ce011962ca8629e766a59316e1cb;p=thirdparty%2FPython%2Fcpython.git

#15183: clarify timeit documentation to say that setup statement isn't timed
---

diff --git a/Doc/library/timeit.rst b/Doc/library/timeit.rst
index 503a705fbc38..70df409fac7c 100644
--- a/Doc/library/timeit.rst
+++ b/Doc/library/timeit.rst
@@ -94,6 +94,8 @@ The module defines three convenience functions and a public class:
    method.  The :meth:`.repeat` method is a convenience to call :meth:`.timeit`
    multiple times and return a list of results.
 
+   The execution time of *setup* is excluded from the overall timed execution run.
+
    The *stmt* and *setup* parameters can also take objects that are callable
    without arguments.  This will embed calls to them in a timer function that
    will then be executed by :meth:`.timeit`.  Note that the timing overhead is a
diff --git a/Lib/timeit.py b/Lib/timeit.py
index 9cec000f7397..cf7446d8c1f5 100755
--- a/Lib/timeit.py
+++ b/Lib/timeit.py
@@ -14,7 +14,8 @@ Command line usage:
 Options:
   -n/--number N: how many times to execute 'statement' (default: see below)
   -r/--repeat N: how many times to repeat the timer (default 3)
-  -s/--setup S: statement to be executed once initially (default 'pass')
+  -s/--setup S: statement to be executed once initially (default 'pass').
+                Execution time of this setup statement is NOT timed.
   -p/--process: use time.process_time() (default is time.perf_counter())
   -t/--time: use time.time() (deprecated)
   -c/--clock: use time.clock() (deprecated)