From 2dcf323077dcd2fe8acc8e843671f26653168ede Mon Sep 17 00:00:00 2001 From: Florian Bruhin Date: Tue, 17 Mar 2015 06:39:02 +0100 Subject: [PATCH] Add missing docstrings. --- qutebrowser/test/utils/test_debug.py | 1 + qutebrowser/utils/debug.py | 6 ++++++ 2 files changed, 7 insertions(+) diff --git a/qutebrowser/test/utils/test_debug.py b/qutebrowser/test/utils/test_debug.py index 12a5afef1..6ec334f8f 100644 --- a/qutebrowser/test/utils/test_debug.py +++ b/qutebrowser/test/utils/test_debug.py @@ -156,6 +156,7 @@ class TestLogTime(unittest.TestCase): """Test log_time.""" def test_log_time(self): + """Test if log_time logs properly.""" logger = logging.getLogger('qt-tests') with self.assertLogs(logger, logging.DEBUG) as logged: with debug.log_time(logger, action='foobar'): diff --git a/qutebrowser/utils/debug.py b/qutebrowser/utils/debug.py index 2ff27e19e..0ccde55ab 100644 --- a/qutebrowser/utils/debug.py +++ b/qutebrowser/utils/debug.py @@ -254,6 +254,12 @@ def format_call(func, args=None, kwargs=None, full=True): @contextlib.contextmanager def log_time(logger, action='operation'): + """Log the time the operation in the with-block takes. + + Args: + logger: The logging.Logger to use for logging. + action: A description of what's being done. + """ started = datetime.datetime.now() yield finished = datetime.datetime.now()