From 7ed9b0a02e66448ceb3e7956322a02cb640c240a Mon Sep 17 00:00:00 2001 From: Jean-Paul Calderone Date: Thu, 21 Feb 2019 14:17:43 -0500 Subject: [PATCH] document this TestCase thing --- src/allmydata/test/test_magic_folder.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/allmydata/test/test_magic_folder.py b/src/allmydata/test/test_magic_folder.py index 6e5b9ba85..ba2e8f1e6 100644 --- a/src/allmydata/test/test_magic_folder.py +++ b/src/allmydata/test/test_magic_folder.py @@ -39,6 +39,15 @@ _debug = False class TestCase(unittest.TestCase): + """ + A ``TestCase`` which collects helpful behaviors for subclasses. + + Those behaviors are: + + * Each test method will be run in a unique Eliot action context which + identifies the test and collects all Eliot log messages emitted by that + test (including setUp and tearDown messages). + """ @eliot_logged_test def run(self, result): return super(TestCase, self).run(result)