Skip to content

Commit

Permalink
Docstrings in numpydoc format.
Browse files Browse the repository at this point in the history
  • Loading branch information
albop committed Oct 16, 2014
1 parent d271a1c commit c4d2ea0
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions quantecon/timing.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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()

0 comments on commit c4d2ea0

Please sign in to comment.