Repository navigation
doc: TerminalReporter is not documented #6649
Description
It could be added as follows, but only rewrite has a docstring and would be included.
It is used with the pytest_terminal_summary hook at least, and therefore is public API it seems.
diff --git i/doc/en/reference.rst w/doc/en/reference.rst
index 50e32d660..552ad895b 100644
--- i/doc/en/reference.rst
+++ w/doc/en/reference.rst
@@ -838,6 +838,13 @@ Session
:members:
:show-inheritance:
+TerminalReporter
+~~~~~~~~~~~~~~~~
+
+.. autoclass:: _pytest.terminal.TerminalReporter
+ :members:
+ :inherited-members:
+
TestReport
~~~~~~~~~~
Activity
shankarj67 commentedon Mar 5, 2020
I would like to work on this. What exactly do I have to do?
blueyed commentedon Mar 6, 2020
@shankarj67
My patch from above might be enough to make it show up in the docs.
Check
tox -e docsto generate them (ormake -C doc/enif you have deps installed).Then create a PR for it.
(but it is only my understanding that it should be documented / included, might be worth waiting for feedback from others)
mcsitter commentedon May 30, 2020
I build the documentation. You can see the result here:
The page is already very long so this addition should not hurt the usability. Of course it is also properly added in the table of contents with all the links (including to source) working properly.
I assume the reason why only
rewriteis shown is because it is the only method with a docstring in the class as the source indicates. Adding relevant docstrings would be great but sadly that is beyond my skills and knowledge.I am happy to open a PR for the fix.
Commit: mcsitter/pytest@5c3296ca21500581224a2e4becefc74995b6752b
soxofaan commentedon Jul 25, 2024
same issue here: I was looking into hook
pytest_terminal_summaryat https://docs.pytest.org/en/latest/reference/reference.html#pytest.hookspec.pytest_terminal_summary but "TerminalReporter" there is a bit of dead end at the moment.I think even the minimal docs from the quickfix mentioned above would be useful as it would at least link to the appropriate source code at https://docs.pytest.org/en/latest/_modules/_pytest/terminal.html, which, while spartan, is a lot better than the current dead end.
Include TerminalReporter in reference docs pytest-dev#6649
Include TerminalReporter in reference docs pytest-dev#6649
soxofaan commentedon Jul 25, 2024
@blueyed I created PR #12661 from your suggestion. Do you want me to include attribution to you in the changelog entry?
soxofaan commentedon Jul 25, 2024
FYI: in the mean time two
TerminalReportermethods got docstrings:wrap_writeandbuild_summary_stats_lineThe added doc section now looks like:
TerminalReporter: add to pytest namespace and fix docstring (issue py…
chore(deps): update dependency pytest to v9 (#305)