commit cebd4b009adca6611e92eb337747f59818e941a6
author Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> Wed Jun 06 10:05:46 2018 -0700
committer Victor Stinner <vstinner@redhat.com> Wed Jun 06 19:05:46 2018 +0200
tree 7be614d316c52b0b003e8a55eae8472e856083a0
parent 016aff77cbf5f63ed051a98ac628522a1cfd40a4

bpo-28240: timeit: Update repeat() doc (GH-7419) (GH-7457)

Document that the default value of repeat changed from 3 to 5 in
Python 3.7.
(cherry picked from commit 3ef769fcd378a7f1cda19c0dfec2e79613d79e48)

Co-authored-by: Victor Stinner <vstinner@redhat.com>

Doc/library/timeit.rst

diff --git a/Doc/library/timeit.rst b/Doc/library/timeit.rst
index d922fd6..93ca940 100644
--- a/Doc/library/timeit.rst
+++ b/Doc/library/timeit.rst
@@ -69,7 +69,7 @@
       The optional *globals* parameter was added.
 
 
-.. function:: repeat(stmt='pass', setup='pass', timer=<default timer>, repeat=3, number=1000000, globals=None)
+.. function:: repeat(stmt='pass', setup='pass', timer=<default timer>, repeat=5, number=1000000, globals=None)
 
    Create a :class:`Timer` instance with the given statement, *setup* code and
    *timer* function and run its :meth:`.repeat` method with the given *repeat*
@@ -79,6 +79,9 @@
    .. versionchanged:: 3.5
       The optional *globals* parameter was added.
 
+   .. versionchanged:: 3.7
+      Default value of *repeat* changed from 3 to 5.
+
 .. function:: default_timer()
 
    The default timer, which is always :func:`time.perf_counter`.
@@ -150,7 +153,7 @@
       .. versionadded:: 3.6
 
 
-   .. method:: Timer.repeat(repeat=3, number=1000000)
+   .. method:: Timer.repeat(repeat=5, number=1000000)
 
       Call :meth:`.timeit` a few times.
 
@@ -171,6 +174,9 @@
          should be interested in.  After that, you should look at the entire
          vector and apply common sense rather than statistics.
 
+      .. versionchanged:: 3.7
+         Default value of *repeat* changed from 3 to 5.
+
 
    .. method:: Timer.print_exc(file=None)
 
@@ -208,7 +214,7 @@
 
 .. cmdoption:: -r N, --repeat=N
 
-   how many times to repeat the timer (default 3)
+   how many times to repeat the timer (default 5)
 
 .. cmdoption:: -s S, --setup=S
 
@@ -246,7 +252,7 @@
 :func:`default_timer` measurements can be affected by other programs running on
 the same machine, so the best thing to do when accurate timing is necessary is
 to repeat the timing a few times and use the best time.  The :option:`-r`
-option is good for this; the default of 3 repetitions is probably enough in
+option is good for this; the default of 5 repetitions is probably enough in
 most cases.  You can use :func:`time.process_time` to measure CPU time.
 
 .. note::