diff --git a/src/_pytest/terminal.py b/src/_pytest/terminal.py index 388dab291..6bfcf839e 100644 --- a/src/_pytest/terminal.py +++ b/src/_pytest/terminal.py @@ -117,9 +117,14 @@ class TestShortLogReport(NamedTuple): """Used to store the test status result category, shortletter and verbose word. For example ``"rerun", "R", ("RERUN", {"yellow": True})``. - category: the class of result, for example “passed”, “skipped”, “error”, or the empty string - letter: the shortletter shown as testing progresses, for example ".", "s", "E", or the empty string. - word: verbose word is shown as testing progresses in verbose mode, for example "PASSED", "SKIPPED", + :ivar category: + The class of result, for example ``“passed”``, ``“skipped”``, ``“error”``, or the empty string. + + :ivar letter: + The short letter shown as testing progresses, for example ``"."``, ``"s"``, ``"E"``, or the empty string. + + :ivar word: + Verbose word is shown as testing progresses in verbose mode, for example ``"PASSED"``, ``"SKIPPED"``. "ERROR", or the empty string. """