document new unittest.TestCase base class for KazooTestHarness

kovalevfm · Jul 23, 2013 · 1bbeece · 1bbeece
1 parent a44b696
commit 1bbeece
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -59,6 +59,9 @@ Bug Handling
 API Changes
 ***********
 
+- The `kazoo.testing.harness.KazooTestHarness` class directly inherits from
+  `unittest.TestCase` and you need to ensure to call its `__init__` method.
+
 - DataWatch no longer takes any parameters besides for the optional function
   during instantiation. The additional options are now implicitly True, with
   the user being left to ignore events as they choose. See the DataWatch

diff --git a/docs/testing.rst b/docs/testing.rst
@@ -30,11 +30,9 @@ Example:
 
 .. code-block:: python
 
-    import unittest
-
     from kazoo.testing import KazooTestHarness
 
-    class MyTest(unittest.TestCase, KazooTestHarness):
+    class MyTest(KazooTestHarness):
         def setUp(self):
             self.setup_zookeeper()
 

diff --git a/kazoo/testing/harness.py b/kazoo/testing/harness.py
@@ -43,7 +43,7 @@ class KazooTestHarness(unittest.TestCase):
 
     Example::
 
-        class MyTestCase(unittest.TestCase, KazooTestHarness):
+        class MyTestCase(KazooTestHarness):
             def setUp(self):
                 self.setup_zookeeper()