From c4d2ea010bfb766b534839ccb420de3a573b3cf3 Mon Sep 17 00:00:00 2001 From: Pablo Winant Date: Thu, 16 Oct 2014 14:17:17 -0400 Subject: [PATCH] Docstrings in numpydoc format. --- quantecon/timing.py | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/quantecon/timing.py b/quantecon/timing.py index 0fef0920f..1105e3ca2 100644 --- a/quantecon/timing.py +++ b/quantecon/timing.py @@ -7,10 +7,16 @@ class __Timer__: '''Computes elapsed time, between tic, tac, and toc. - - tic(): resets timer - - toc(): returns and prints time elapsed since last tic() - - tac(): returns and prints time elapsed since last - tic(), tac() or toc() whichever occured last + + Methods + ------- + tic : + Resets timer. + toc : + Returns and prints time elapsed since last tic(). + tac : + Returns and prints time elapsed since last + tic(), tac() or toc() whichever occured last. ''' start = None @@ -67,9 +73,9 @@ def tic(): return __timer__.tic() def tac(): - """Prints and return elapsed time since last tic, tac or toc.""" + """Prints and returns elapsed time since last tic, tac or toc.""" return __timer__.tac() def toc(): - """Prints and return elapsed time since last tic, tac or toc.""" + """Prints and returns elapsed time since last tic, tac or toc.""" return __timer__.toc()