DOC: update doc.

DOC: update docs.
This commit is contained in:
Maya Tydykov
2016-03-08 15:48:37 -05:00
parent c87293942f
commit 195c2fffb6
+9
View File
@@ -888,8 +888,17 @@ def make_test_handler(testcase, *args, **kwargs):
Returns a TestHandler which will be used by the given testcase. This
handler can be used to test log messages.
Parameters
----------
testcase: unittest.TestCase
The test class in which the log handler will be used.
*args, **kwargs
Forwarded to the new TestHandler object.
Returns
-------
handler: logbook.TestHandler
The handler to use for the test case.
"""
handler = TestHandler(*args, **kwargs)
testcase.addCleanup(handler.close)