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 ae65a1d..501f126 100644
--- a/Lib/packaging/tests/support.py
+++ b/Lib/packaging/tests/support.py
@@ -65,7 +65,10 @@
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):