Updates unittest docs

garry-cairns · garry-cairns · commit 7881c641e1f3 · 2025-06-23T20:48:55.000+01:00
diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst
@@ -1131,7 +1131,7 @@ Test cases
       .. versionchanged:: 3.3
          Added the *msg* keyword argument when used as a context manager.
 
-   .. method:: assertLogs(logger=None, level=None)
+   .. method:: assertLogs(logger=None, level=None, formatter=None)
 
       A context manager to test that at least one message is logged on
       the *logger* or one of its children, with at least the given
@@ -1146,6 +1146,10 @@ Test cases
       its string equivalent (for example either ``"ERROR"`` or
       :const:`logging.ERROR`).  The default is :const:`logging.INFO`.
 
+      If given, *formatter* should be a :class:`logging.Formatter` object.
+      The default is a formatter with
+      ``LOGGING_FORMAT = "%(levelname)s:%(name)s:%(message)s"``
+
       The test passes if at least one message emitted inside the ``with``
       block matches the *logger* and *level* conditions, otherwise it fails.
 
@@ -1173,6 +1177,10 @@ Test cases
 
       .. versionadded:: 3.4
 
+      .. versionchanged:: 3.15
+         Now accepts a formatter argument so your assertions can match
+         a custom format where you are using one.
+
    .. method:: assertNoLogs(logger=None, level=None)
 
       A context manager to test that no messages are logged on
