update documentation for tools.py

1 files changed, 4 insertions, 2 deletions

diff --git a/tools.py b/tools.py
index ba36f6d..1338526 100644
--- a/tools.py
+++ b/tools.py
@@ -17,16 +17,18 @@ def debugger_hook(type, value, tb):
        pdb.pm()
 
 def enable_debug_on_crash():
-    '''Start the PDB console when an uncaught exception propagates to the top.'''
+    "Start the PDB console when an uncaught exception propagates to the top."
     sys.excepthook = debugger_hook
 
-# Allow profile decorator to exist, but do nothing if not running under kernprof
+# allow profile decorator to exist, but do nothing if not running under
+# kernprof
 try:
     profile_if_possible = profile
 except NameError:
     profile_if_possible = lambda x: x
 
 def timeit(func):
+    "A decorator to print the time elapsed in a function call."
     def f(*args, **kwargs):
         t0 = time.time()
         retval = func(*args, **kwargs)