From 709370b2198e09f1dbe195fe8813602a3125b7f6 Mon Sep 17 00:00:00 2001 From: Scott Gasch Date: Wed, 8 Sep 2021 23:29:05 -0700 Subject: Add doctests to some of this stuff. --- stopwatch.py | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) (limited to 'stopwatch.py') diff --git a/stopwatch.py b/stopwatch.py index 1326cb1..cdd405b 100644 --- a/stopwatch.py +++ b/stopwatch.py @@ -6,11 +6,15 @@ from typing import Callable class Timer(object): """ - with timer.Timer() as t: - do_the_thing() + A stopwatch to time how long something takes (walltime). - walltime = t() - print(f'That took {walltime}s.') + e.g. + + with timer.Timer() as t: + do_the_thing() + + walltime = t() + print(f'That took {walltime} seconds.') """ def __init__(self) -> None: @@ -18,6 +22,9 @@ class Timer(object): self.end = None def __enter__(self) -> Callable[[], float]: + """Returns a functor that, when called, returns the walltime of the + operation in seconds. + """ self.start = time.perf_counter() self.end = 0.0 return lambda: self.end - self.start -- cgit v1.3