From 530b0050b44b6d9546d7064456919430f6fa46f7 Mon Sep 17 00:00:00 2001 From: Bruno Oliveira Date: Wed, 3 Aug 2016 21:57:58 -0300 Subject: [PATCH] Improve TestReport.sections docs a bit Related to #1790 --- _pytest/runner.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/_pytest/runner.py b/_pytest/runner.py index a0a0c6203..525a2b00f 100644 --- a/_pytest/runner.py +++ b/_pytest/runner.py @@ -306,8 +306,10 @@ class TestReport(BaseReport): #: one of 'setup', 'call', 'teardown' to indicate runtest phase. self.when = when - #: list of (secname, data) extra information which needs to - #: marshallable + #: list of pairs ``(str, str)`` of extra information which needs to + #: marshallable. Used by pytest to add captured text + #: from ``stdout`` and ``stderr``, but may be used by other plugins + #: to add arbitrary information to reports. self.sections = list(sections) #: time it took to run just the test