Add note documenting pytest-dev#2257

vmuriart · Feb 17, 2017 · a88017c · a88017c
1 parent 58d7f4e
commit a88017c
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/_pytest/hookspec.py b/_pytest/hookspec.py
@@ -263,7 +263,14 @@ def pytest_assertrepr_compare(config, op, left, right):
 # -------------------------------------------------------------------------
 
 def pytest_report_header(config, startdir):
- """ return a string to be displayed as header info for terminal reporting."""
+ """ return a string to be displayed as header info for terminal reporting.
+
+ .. note::
+
+ This function should be implemented only in plugins or ``conftest.py``
+ files situated at the tests root directory due to how pytest
+ :ref:`discovers plugins during startup <pluginorder>`.
+ """
 
 @hookspec(firstresult=True)
 def pytest_report_teststatus(report):