[8.2.x] Clarify pytest_ignore_collect docs

This commit is contained in:
Bruno Oliveira 2024-05-28 13:47:00 -03:00 committed by pytest bot
parent 240a252d34
commit 4a0651403d
1 changed files with 6 additions and 1 deletions

View File

@ -310,7 +310,12 @@ def pytest_collection_finish(session: "Session") -> None:
def pytest_ignore_collect(
collection_path: Path, path: "LEGACY_PATH", config: "Config"
) -> Optional[bool]:
"""Return True to prevent considering this path for collection.
"""Return ``True`` to ignore this path for collection.
Return ``None`` to let other plugins ignore the path for collection.
Returning ``False`` will forcefully *not* ignore this path for collection,
without giving a chance for other plugins to ignore this path.
This hook is consulted for all files and directories prior to calling
more specific hooks.