[tor-commits] [bridgedb/develop] Add test_txrecaptcha note about `DelayedCall`s and dirty reactor cleanups.

[isis at torproject.org]

commit 4b77a4271b64d7846ac2440010a9fa0080445455
Author: Isis Lovecruft <isis at torproject.org>
Date:   Wed Mar 12 23:02:01 2014 +0000

    Add test_txrecaptcha note about `DelayedCall`s and dirty reactor cleanups.
---
 lib/bridgedb/test/test_txrecaptcha.py |    8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/lib/bridgedb/test/test_txrecaptcha.py b/lib/bridgedb/test/test_txrecaptcha.py
index 1755011..8226b6d 100644
--- a/lib/bridgedb/test/test_txrecaptcha.py
+++ b/lib/bridgedb/test/test_txrecaptcha.py
@@ -213,7 +213,13 @@ class SubmitTests(unittest.TestCase):
         return d
 
     def tearDown(self):
-        """Cleanup method for removing timed out connections on the reactor."""
+        """Cleanup method for removing timed out connections on the reactor.
+
+        This seems to be the solution for the dirty reactor due to
+        ``DelayedCall``s which is mentioned at the beginning of this
+        file. There doesn't seem to be any documentation anywhere which
+        proposes this solution, although this seems to solve the problem.
+        """
         for delay in reactor.getDelayedCalls():
             try:
                 delay.cancel()