From 76ab94e4a04084e472dfccac2013f391db6fede6 Mon Sep 17 00:00:00 2001 From: wim glenn Date: Thu, 25 Mar 2021 22:25:19 -0500 Subject: [PATCH] fix some bunk formatting in the CollectReport, and reword the description of the 'sections' attribute --- src/_pytest/reports.py | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/src/_pytest/reports.py b/src/_pytest/reports.py index b4013f6a2f6..6be6000e802 100644 --- a/src/_pytest/reports.py +++ b/src/_pytest/reports.py @@ -281,10 +281,10 @@ def __init__( #: defined properties of the test. self.user_properties = list(user_properties or []) - #: 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. + #: Tuples of str ``(heading, content)`` with extra information + #: for the test report. Used by pytest to add text captured + #: from ``stdout``, ``stderr``, and intercepted logging events. May + #: be used by other plugins to add arbitrary information to reports. self.sections = list(sections) #: Time it took to run just the test. @@ -381,11 +381,10 @@ def __init__( #: The collected items and collection nodes. self.result = result or [] - #: 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. + #: Tuples of str ``(heading, content)`` with extra information + #: for the test report. Used by pytest to add text captured + #: from ``stdout``, ``stderr``, and intercepted logging events. May + #: be used by other plugins to add arbitrary information to reports. self.sections = list(sections) self.__dict__.update(extra)