This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: timeit documention still refers to the timeit.py script
Type: Stage: resolved
Components: Library (Lib) Versions: Python 3.2, Python 3.3, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Boris.FELD, alexis, docs@python, ezio.melotti, orsenthil, python-dev, sandro.tosi
Priority: low Keywords: easy

Created on 2011-08-05 16:11 by alexis, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Messages (4)
msg141663 - (view) Author: Alexis Metaireau (alexis) * (Python triager) Date: 2011-08-05 16:11
The example section of the timeit documentation still refers to "timeit.py", and isn't using the "python -m timeit" syntax used above.
http://docs.python.org/library/timeit.html#examples

I'm not sure when and if the timeit.py script has been removed from the python installation (and I'm not sure on where to look for this).

The timeit.py docstring also refers to this "old" syntax. Should we update it?

All credit for this report goes to Boris Feld.
msg141679 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2011-08-05 19:51
Sounds good to me.

I would also replace the % with $ in the first example and use triple-quoted docstrings and spaces around the == in the last.
msg141709 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2011-08-06 05:37
New changeset fa1e5fe55664 by Senthil Kumaran in branch '2.7':
Fix closes Issue12697 - Update the usage syntax of timeit module in the docs.
http://hg.python.org/cpython/rev/fa1e5fe55664

New changeset 87de58db3d40 by Senthil Kumaran in branch '3.2':
Fix closes Issue12697 - Update the usage syntax of timeit module in the docs.
http://hg.python.org/cpython/rev/87de58db3d40

New changeset 46b801545126 by Senthil Kumaran in branch 'default':
merge from 3.2 - Fix closes Issue12697 - Update the usage syntax of timeit module in the docs.
http://hg.python.org/cpython/rev/46b801545126
msg141710 - (view) Author: Senthil Kumaran (orsenthil) * (Python committer) Date: 2011-08-06 05:38
Thanks for the report, Boris Feld and Alexis.
History
Date User Action Args
2022-04-11 14:57:20adminsetgithub: 56906
2011-08-06 05:38:33orsenthilsetassignee: alexis -> docs@python

messages: + msg141710
nosy: + docs@python, orsenthil
2011-08-06 05:37:56python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg141709

resolution: fixed
stage: needs patch -> resolved
2011-08-05 19:51:29ezio.melottisetversions: - Python 2.6, Python 3.1, Python 3.4
nosy: + sandro.tosi, ezio.melotti

messages: + msg141679

keywords: + easy
stage: needs patch
2011-08-05 16:12:18alexissettitle: timeiot documention still refers to the timeit.py script -> timeit documention still refers to the timeit.py script
2011-08-05 16:11:53alexissetnosy: + Boris.FELD
2011-08-05 16:11:33alexiscreate