Commit graph

57 commits

Author SHA1 Message Date
Hugo van Kemenade
f31a89bb90 Python 3.15.0b1 2026-05-07 16:26:31 +03:00
Hugo van Kemenade
9514dd750c
gh-133879: Copyedit "What's new in Python 3.15" (#149451) 2026-05-06 20:33:08 +03:00
Hugo van Kemenade
55ea59e7dc Python 3.15.0a8 2026-04-07 14:24:03 +03:00
Miikka Koskinen
f3b74d6269
gh-80642: timeit - make target time of autorange configurable (#140283)
Co-authored-by: Alessandro Cucci <alessandro.cucci@gmail.com>
Co-authored-by: blurb-it[bot] <blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Stan Ulbrych <stan@python.org>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2026-04-03 06:47:21 +00:00
Ned Batchelder
638d22c6e7
Docs: module pages should not link to themselves (#144505)
* Docs: module pages should not link to themselves

* fix header punctuation
2026-02-06 06:48:27 -05:00
Ned Batchelder
bcb435ee8f
docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
Towster15
a973bf0f97
gh-110383 TimeIt Docs Spelling Fix (#110407)
Make 0.2 second plural
2023-10-05 17:01:35 +00:00
Adam Turner
77e9aae383
Docs: Avoid the deprecated `.. cmdoption::` directive (#110292) 2023-10-03 17:38:12 +00:00
R
7096a2be33
gh-105052:update timeit function's description (#105060)
---------
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-08-27 03:22:27 -04:00
Terry Jan Reedy
04dfc6fa90
gh-106232: Make timeit doc command lines compatible with Windows. (#106296)
Command Prompt (CMD Shell) and older versions of PowerShell
require double quotes and single quotes inside the string.
This form also works on linux and macOS.
2023-06-30 22:34:31 -04:00
busywhitespace
9b60ee976a
gh-101221: Add options in the documentation of timeit command (#101222) 2023-02-05 15:25:36 +05:30
Mariusz Felisiak
847d7708ba
gh-98763: Prefer "python" over "python3" for command line examples in docs. (#98761) 2023-01-11 15:35:41 +05:30
Hugo van Kemenade
73140de97c
bpo-23183: Document the timeit output (GH-30359)
Co-authored-by: Robert Collins <robertc@robertcollins.net>
2022-01-14 17:25:36 +00:00
Serhiy Storchaka
233b9da07d
[docs] Use full names for time units (GH-28611)
Use "second", "millisecond", "microsecond", "nanosecond" instead of
"sec", "ms", "msec", "us", "ns", etc.
2021-09-29 12:09:56 +03:00
Terry Jan Reedy
604cd71e50
Specify Python Cookbook edition for reference (GH-26301)
The timeit doc references Tim Peters introduction to the Chapter 18,
Algorithms, of the second edition.  The first editiion was before timeit.
The third edition instead has Chapter 1, Data Structures and Algorithms,
without Tim's introduction.
2021-05-21 15:17:10 -07:00
Andre Delfino
594f0ce73b
[doc] Fix padding in timeit (GH-22152)
Compare -p and -u options help in rendered output to see the difference.
2020-09-08 16:39:19 -07:00
Sander
766352320f
bpo-40419: timeit CLI docs now mention 1,2,5,10,... trials instead of powers of 10 (GH-19752) 2020-05-02 19:12:05 +03:00
Anders Hovmöller
8da5ebe11e bpo-35138: Added an example for timeit.timeit with callable arguments (GH-9787)
* Update timeit.rst
2019-05-13 21:27:17 +02:00
Shiv Dhar
4064089fce Fix grammar error in timeit module docs (GH-12066)
skip issue
skip news
2019-02-27 15:21:15 -08:00
Henry Chen
06f8b57212 bpo-35738: Update the example for timer.Timer.repeat(). (GH-11559)
Show correct number of repeats.
2019-01-15 12:29:21 +02:00
Victor Stinner
3ef769fcd3
bpo-28240: timeit: Update repeat() doc (GH-7419)
Document that the default value of repeat changed from 3 to 5 in
Python 3.7.
2018-06-06 17:55:18 +02:00
Serhiy Storchaka
46936d5a71
Improve highlighting of some code blocks. (GH-6401) 2018-04-08 19:18:04 +03:00
Xiang Zhang
210d6a9f95 bpo-29662: fix wrong indentation in timeit.Timer's doc (GH-332) 2017-02-27 13:42:01 +08:00
Serhiy Storchaka
d3ff784f2d Issue #28469: timeit now uses the sequence 1, 2, 5, 10, 20, 50,... instead
of 1, 10, 100,... for autoranging.
2016-10-23 15:17:05 +03:00
Serhiy Storchaka
c2e9983060 Issue #19795: Mark up None as literal text. 2016-10-19 16:39:36 +03:00
Serhiy Storchaka
989db5c880 Issue #19795: Mark up None as literal text. 2016-10-19 16:37:13 +03:00
Victor Stinner
c3e40f8c5b timeit: add nsec (nanosecond) unit for format timings
Issue #28240.
2016-10-18 17:42:48 +02:00
Victor Stinner
3d7feb9ac2 timeit: remove --clock and --time options
Issue #28240: timeit: remove -c/--clock and -t/--time command line options
which were deprecated since Python 3.3.
2016-10-18 17:18:21 +02:00
Steven D'Aprano
a0d3eeff86 Add versionadded tag to docs for timeit.autorange 2016-08-15 02:47:49 +10:00
Steven D'Aprano
09f4f711b6 Issue6422 add autorange method to timeit.Timer 2016-08-15 01:27:03 +10:00
Terry Jan Reedy
fa089b9b0b Issue #22558: Add remaining doc links to source code for Python-coded modules.
Reformat header above separator line (added if missing) to a common format.
Patch by Yoni Lavi.
2016-06-11 15:02:54 -04:00
Martin Panter
00ccacc8db Issue #26638: Fix links to some CLI options and section headings
* Disable inappropriate links to Python interpreter options
* Correct link to CLI section in zipapp
* Make CLI section label in timeit less ambiguous
2016-04-16 04:59:38 +00:00
Andrew Kuchling
c3a7f18100 Merge from 3.4 2015-04-21 19:44:54 -04:00
Andrew Kuchling
333518e01d #15183: clarify timeit documentation to say that setup statement isn't timed 2015-04-21 19:43:33 -04:00
Robert Collins
302dbc6792 Issue #18983: Allow selection of output units in timeit.
This allows manual selection of a specific unit such as usecs rather than the
use of a heuristic. This is intended to aid machine processing of timeit
output.

Patch by Serhiy Storchaka.
2015-03-18 09:54:50 +13:00
Serhiy Storchaka
c959b0cd30 Issue #18518: timeit now rejects statements which can't be compiled outside
a function or a loop (e.g. "return" or "break").
2015-01-26 12:09:59 +02:00
Serhiy Storchaka
2bef58577f Issue #18518: timeit now rejects statements which can't be compiled outside
a function or a loop (e.g. "return" or "break").
2015-01-26 12:09:17 +02:00
Antoine Pitrou
ef3b9ed0ac Issue #2527: Add a *globals* argument to timeit functions, in order to override the globals namespace in which the timed code is executed.
Patch by Ben Roberts.
2014-08-22 23:13:50 -04:00
Ezio Melotti
591176e544 #18588: update the timeit examples to be consistent. 2014-08-04 17:01:16 +03:00
Andrew Kuchling
44da19a63d #18518: mention that including a return statement changes/breaks the behaviour 2014-04-14 13:39:43 -04:00
Andrew Svetlov
47395617bc Issue #16261: fix bare excepts in Doc/ 2012-11-02 22:07:26 +02:00
Ezio Melotti
4443762bf5 #15979: merge with 3.2. 2012-10-02 06:01:16 +03:00
Ezio Melotti
d0fe3e5abb #15979: improve timeit documentation. 2012-10-02 05:35:39 +03:00
Ezio Melotti
f6813f6071 Merge rst markup fixes in timeit docs with 3.2. 2012-09-20 06:14:54 +03:00
Ezio Melotti
a3ccb237c7 Fix rst markup in timeit docs. 2012-09-20 06:13:38 +03:00
Georg Brandl
67c1444454 Update timeit documentation w.r.t default timer changes. 2012-05-01 11:59:36 +02:00
Sandro Tosi
e6c3462607 Issue #13478: document timeit.default_timer() 2012-04-24 18:11:46 +02:00
Senthil Kumaran
2e0153550c Fix closes Issue12697 - Update the usage syntax of timeit module in the docs. 2011-08-06 13:37:04 +08:00
Raymond Hettinger
a199368b23 More source links. 2011-01-27 01:20:32 +00:00
Éric Araujo
713d3039dc Fix usage of :option: in the docs (#9312).
:option: is used to create a link to an option of python, not to mark
up any instance of any arbitrary command-line option.  These were
changed to ````.

For modules which do have a command-line interface, lists of options
have been properly marked up with the program/cmdoption directives
combo.  Options defined in such blocks can be linked to with :option:
later in the same file, they won’t link to an option of python.

Finally, the markup of command-line fragments in optparse.rst has
been cleaned to use ``x`` instead of ``"x"``, keeping that latter
form for actual Python strings.

Patch by Eli Bendersky and Éric Araujo.
2010-11-18 16:38:46 +00:00