docs: improve timeit autorange description#144825
Open
scop wants to merge 1 commit intopython:mainfrom
Open
Conversation
0a0889d to
e2d6e7a
Compare
It not only determines but actually runs timeit a number of times. Also be more concise; the original form said basically the same thing twice.
e2d6e7a to
06df2b1
Compare
bkap123
reviewed
Feb 18, 2026
Contributor
bkap123
left a comment
There was a problem hiding this comment.
I left a few small changes to try to make it clearer that the number of iterations increases until it takes long enough.
| .. method:: Timer.autorange(callback=None) | ||
|
|
||
| Automatically determine how many times to call :meth:`.timeit`. | ||
| Call :meth:`.timeit` automatically determined number of times. |
Contributor
There was a problem hiding this comment.
Suggested change
| Call :meth:`.timeit` automatically determined number of times. | |
| Call :meth:`.timeit` an automatically determined number of times. |
| Automatically determine how many times to call :meth:`.timeit`. | ||
| Call :meth:`.timeit` automatically determined number of times. | ||
|
|
||
| This is a convenience function that calls :meth:`.timeit` repeatedly |
Contributor
There was a problem hiding this comment.
Suggested change
| This is a convenience function that calls :meth:`.timeit` repeatedly | |
| This is a convenience function that repeatedly calls :meth:`.timeit` |
| (number of loops, time taken for that number of loops). It calls | ||
| :meth:`.timeit` with increasing numbers from the sequence 1, 2, 5, | ||
| 10, 20, 50, ... until the time taken is at least 0.2 seconds. | ||
| with increasing numbers from the sequence 1, 2, 5, 10, 20, 50, ... |
Contributor
There was a problem hiding this comment.
Suggested change
| with increasing numbers from the sequence 1, 2, 5, 10, 20, 50, ... | |
| with an increasing amount of iterations from the sequence 1, 2, 5, 10, 20, 50, ... |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
It not only determines but actually runs timeit a number of times. Also be more concise; the original form said basically the same thing twice.
📚 Documentation preview 📚: https://cpython-previews--144825.org.readthedocs.build/