Include TerminalReporter in reference docs #6649

changelog/6649.doc.rst

@@ -0,0 +1 @@
+Added :class:`~pytest.TerminalReporter` to the :ref:`api-reference` documentation page.

changelog/6649.misc.rst

@@ -0,0 +1 @@
+Added :class:`~pytest.TerminalReporter` to the public pytest API, as it is part of the signature of the :hook:`pytest_terminal_summary` hook.

doc/en/reference/reference.rst

@@ -1013,6 +1013,13 @@ PytestPluginManager
     :inherited-members:
     :show-inheritance:
 
+TerminalReporter
+~~~~~~~~~~~~~~~~
+
+.. autoclass:: pytest.TerminalReporter
+    :members:
+    :inherited-members:
+
 TestReport
 ~~~~~~~~~~
 

src/_pytest/terminal.py

@@ -1340,7 +1340,7 @@ def build_summary_stats_line(self) -> tuple[list[tuple[str, dict[str, bool]]], s
         The summary stats line is the line shown at the end, "=== 12 passed, 2 errors in Xs===".
 
         This function builds a list of the "parts" that make up for the text in that line, in
-        the example above it would be:
+        the example above it would be::
 
             [
                 ("12 passed", {"green": True}),

src/pytest/__init__.py

@@ -68,6 +68,7 @@
 from _pytest.runner import CallInfo
 from _pytest.stash import Stash
 from _pytest.stash import StashKey
+from _pytest.terminal import TerminalReporter
 from _pytest.terminal import TestShortLogReport
 from _pytest.tmpdir import TempPathFactory
 from _pytest.warning_types import PytestAssertRewriteWarning
@@ -161,6 +162,7 @@
     "version_tuple",
     "TempdirFactory",
     "TempPathFactory",
+    "TerminalReporter",
     "Testdir",
     "TestReport",
     "TestShortLogReport",