From: Andrew Kuchling <amk@amk.ca>
Date: Mon, 14 Apr 2014 17:39:43 +0000 (-0400)
Subject: #18518: mention that including a return statement changes/breaks the behaviour
X-Git-Tag: v3.4.1rc1~89
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=44da19a63d332a11df16475744355e091c89f3b8;p=thirdparty%2FPython%2Fcpython.git

#18518: mention that including a return statement changes/breaks the behaviour
---

diff --git a/Doc/library/timeit.rst b/Doc/library/timeit.rst
index 0cc15868db6a..824a8a316051 100644
--- a/Doc/library/timeit.rst
+++ b/Doc/library/timeit.rst
@@ -63,6 +63,12 @@ The module defines three convenience functions and a public class:
    Create a :class:`Timer` instance with the given statement, *setup* code and
    *timer* function and run its :meth:`.timeit` method with *number* executions.
 
+   .. note::
+
+        Because :meth:`.timeit` is executing *stmt*, placing a return statement
+        in *stmt* will prevent :meth:`.timeit` from returning execution time.
+        It will instead return the data specified by your return statement.
+
 
 .. function:: repeat(stmt='pass', setup='pass', timer=<default timer>, repeat=3, number=1000000)