Skip to content

gh-42765 timeit.Timer Documentation Update #108744

Closed
richardhob wants to merge 9995 commits intopython:mainfrom
richardhob:gh42765-timit-execution-environment
Closed

gh-42765 timeit.Timer Documentation Update #108744
richardhob wants to merge 9995 commits intopython:mainfrom
richardhob:gh42765-timit-execution-environment

Conversation

@richardhob
Copy link
Copy Markdown
Contributor

@richardhob richardhob commented Sep 1, 2023

Update the timeit documentation based on discussion in issue #42765.

Resolve Issue #42765

This issue discusses the documentation for the timeit.Timer class, as well as possible improvements. elibendersky provided a patch to update the documentation, and rurpy improved on this in a post. This merge request implements rurpy's version of the timeit.Timer class documentation with some light edits.

The goal of this documentation change is to better explain how to use timeit.Timer, what the input arguments are, and how the args are use to actually time the execution of the provided snippet.


📚 Documentation preview 📚: https://cpython-previews--108744.org.readthedocs.build/

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting core review docs Documentation in the Doc dir stale Stale PR or inactive for long period of time.

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.