Skip to content

Commit 878a51e

Browse files
authored
Merge pull request #8493 from pytest-dev/docs-fix
tweak documentation of report's sections attribute
2 parents d9f4ced + 76ab94e commit 878a51e

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

src/_pytest/reports.py

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -281,10 +281,10 @@ def __init__(
281281
#: defined properties of the test.
282282
self.user_properties = list(user_properties or [])
283283

284-
#: List of pairs ``(str, str)`` of extra information which needs to
285-
#: marshallable. Used by pytest to add captured text
286-
#: from ``stdout`` and ``stderr``, but may be used by other plugins
287-
#: to add arbitrary information to reports.
284+
#: Tuples of str ``(heading, content)`` with extra information
285+
#: for the test report. Used by pytest to add text captured
286+
#: from ``stdout``, ``stderr``, and intercepted logging events. May
287+
#: be used by other plugins to add arbitrary information to reports.
288288
self.sections = list(sections)
289289

290290
#: Time it took to run just the test.
@@ -381,11 +381,10 @@ def __init__(
381381
#: The collected items and collection nodes.
382382
self.result = result or []
383383

384-
#: List of pairs ``(str, str)`` of extra information which needs to
385-
#: marshallable.
386-
# Used by pytest to add captured text : from ``stdout`` and ``stderr``,
387-
# but may be used by other plugins : to add arbitrary information to
388-
# reports.
384+
#: Tuples of str ``(heading, content)`` with extra information
385+
#: for the test report. Used by pytest to add text captured
386+
#: from ``stdout``, ``stderr``, and intercepted logging events. May
387+
#: be used by other plugins to add arbitrary information to reports.
389388
self.sections = list(sections)
390389

391390
self.__dict__.update(extra)

0 commit comments

Comments
 (0)