[Python-checkins] cpython (3.4): #18518: mention that including a return statement changes/breaks the behaviour

[andrew.kuchling]

http://hg.python.org/cpython/rev/7e2708484ea5
changeset:   90275:7e2708484ea5
branch:      3.4
parent:      90273:0d64a930e846
user:        Andrew Kuchling <amk at amk.ca>
date:        Mon Apr 14 13:39:43 2014 -0400
summary:
  #18518: mention that including a return statement changes/breaks the behaviour

files:
  Doc/library/timeit.rst |  6 ++++++
  1 files changed, 6 insertions(+), 0 deletions(-)


diff --git a/Doc/library/timeit.rst b/Doc/library/timeit.rst
--- a/Doc/library/timeit.rst
+++ b/Doc/library/timeit.rst
@@ -63,6 +63,12 @@
    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)
 

-- 
Repository URL: http://hg.python.org/cpython