Add docs for Item.add_report_section in the docs

Fix #2381
This commit is contained in:
Bruno Oliveira 2017-07-11 21:45:27 -03:00
parent 9e0b19cce2
commit 73b07e1439
1 changed files with 15 additions and 0 deletions

View File

@ -518,6 +518,21 @@ class Item(Node):
self._report_sections = []
def add_report_section(self, when, key, content):
"""
Adds a new report section, similar to what's done internally to add stdout and
stderr captured output::
item.add_report_section("call", "stdout", "report section contents")
:param str when:
One of the possible capture states, ``"setup"``, ``"call"``, ``"teardown"``.
:param str key:
Name of the section, can be customized at will. Pytest uses ``"stdout"`` and
``"stderr"`` internally.
:param str content:
The full contents as a string.
"""
if content:
self._report_sections.append((when, key, content))