From 2a38ca8a0cc9f59266874ca3cf3c0c8b080fd42e Mon Sep 17 00:00:00 2001
From: Ran Benita <ran@unusedvar.com>
Date: Sun, 14 Jun 2020 16:02:25 +0300
Subject: [PATCH] doc/reference: add CollectReport

CollectReport appears in several hooks, so we should document it. It's
runtest equivalent TestReport is already documented.
---
 doc/en/reference.rst   |  8 ++++++++
 src/_pytest/reports.py | 15 +++++++++++++++
 2 files changed, 23 insertions(+)

diff --git a/doc/en/reference.rst b/doc/en/reference.rst
index d21cdd3e9..bc501c1ad 100644
--- a/doc/en/reference.rst
+++ b/doc/en/reference.rst
@@ -762,6 +762,14 @@ Collector
     :members:
     :show-inheritance:
 
+CollectReport
+~~~~~~~~~~~~~
+
+.. autoclass:: _pytest.runner.CollectReport()
+    :members:
+    :show-inheritance:
+    :inherited-members:
+
 Config
 ~~~~~~
 
diff --git a/src/_pytest/reports.py b/src/_pytest/reports.py
index 6a408354b..8b213ed13 100644
--- a/src/_pytest/reports.py
+++ b/src/_pytest/reports.py
@@ -335,6 +335,8 @@ class TestReport(BaseReport):
 
 
 class CollectReport(BaseReport):
+    """Collection report object."""
+
     when = "collect"
 
     def __init__(
@@ -346,11 +348,24 @@ class CollectReport(BaseReport):
         sections: Iterable[Tuple[str, str]] = (),
         **extra
     ) -> None:
+        #: normalized collection node id
         self.nodeid = nodeid
+
+        #: test outcome, always one of "passed", "failed", "skipped".
         self.outcome = outcome
+
+        #: None or a failure representation.
         self.longrepr = longrepr
+
+        #: 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.
         self.sections = list(sections)
+
         self.__dict__.update(extra)
 
     @property