From 1bd7d287a78639a03d2e1ffb1b70cef407cfa5d7 Mon Sep 17 00:00:00 2001 From: DamianSkrzypczak Date: Thu, 2 May 2019 20:48:03 +0200 Subject: [PATCH] doc: fix hooks 'path' parameter doc type by changing it from str to py.path.local (#5171) --- src/_pytest/hookspec.py | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/src/_pytest/hookspec.py b/src/_pytest/hookspec.py index 5a3eb282d..02b1b4524 100644 --- a/src/_pytest/hookspec.py +++ b/src/_pytest/hookspec.py @@ -188,7 +188,7 @@ def pytest_ignore_collect(path, config): Stops at first non-None result, see :ref:`firstresult` - :param str path: the path to analyze + :param path: a :py:class:`py.path.local` - the path to analyze :param _pytest.config.Config config: pytest config object """ @@ -199,7 +199,7 @@ def pytest_collect_directory(path, parent): Stops at first non-None result, see :ref:`firstresult` - :param str path: the path to analyze + :param path: a :py:class:`py.path.local` - the path to analyze """ @@ -207,7 +207,7 @@ def pytest_collect_file(path, parent): """ return collection Node or None for the given path. Any new node needs to have the specified ``parent`` as a parent. - :param str path: the path to collect + :param path: a :py:class:`py.path.local` - the path to collect """ @@ -249,7 +249,10 @@ def pytest_pycollect_makemodule(path, parent): The pytest_collect_file hook needs to be used if you want to create test modules for files that do not match as a test module. - Stops at first non-None result, see :ref:`firstresult` """ + Stops at first non-None result, see :ref:`firstresult` + + :param path: a :py:class:`py.path.local` - the path of module to collect + """ @hookspec(firstresult=True)