From: Éric Araujo <merwok@netwok.org>
Date: Fri, 3 Jun 2011 15:28:23 +0000 (+0200)
Subject: Document autoflushing in packaging.test.support.LoggingCatcher.get_logs.
X-Git-Tag: v3.3.0a1~2183^2~8
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=5d5bde1df2e92fcd545baeef4fb212462982e47e;p=python

Document autoflushing in packaging.test.support.LoggingCatcher.get_logs.

I’m afraid my docstring is not as clear as it should be, but I can’t
find a concise way of describing what the code does.  Suggestions for
improvements welcome.
---

diff --git a/Lib/packaging/tests/support.py b/Lib/packaging/tests/support.py
index ae65a1db3b..501f1260a3 100644
--- a/Lib/packaging/tests/support.py
+++ b/Lib/packaging/tests/support.py
@@ -65,7 +65,10 @@ class LoggingCatcher:
     configured to record all messages logged to the 'packaging' logger.
 
     Use get_logs to retrieve messages and self.loghandler.flush to discard
-    them.
+    them.  get_logs automatically flushes the logs; if you test code that
+    generates logging messages but don't use get_logs, you have to flush
+    manually before doing other checks on logging message, otherwise you
+    will get irrelevant results.  See example in test_command_check.
     """
 
     def setUp(self):