Add docstring

This commit is contained in:
Roberto Aldera 2023-05-14 18:40:30 +02:00
parent d126158421
commit d3502ac4d8
No known key found for this signature in database
1 changed files with 9 additions and 0 deletions

View File

@ -547,6 +547,15 @@ class TerminalReporter:
self.flush()
class TestStatus(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",
"ERROR", or the empty string.
"""
category: str
letter: str
word: Union[str, Tuple[str, Mapping[str, bool]]]