floraachy
/
pytest2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: fix hooks 'path' parameter doc type (#5198) 

doc: fix hooks 'path' parameter doc type
This commit is contained in:
Bruno Oliveira 2019-05-02 21:05:07 -03:00 committed by GitHub
parent b82e1b87cc 299e6479c1
commit 1c13418a8b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
AUTHORS
View File

@ -59,6 +59,7 @@ Christopher Gilling
Christopher Dignam Christopher Dignam
CrazyMerlyn CrazyMerlyn
Cyrus Maden Cyrus Maden
Damian Skrzypczak
Dhiren Serai Dhiren Serai
Daniel Grana Daniel Grana
Daniel Hahler Daniel Hahler

1
changelog/5171.doc.rst Normal file
View File

@ -0,0 +1 @@
Doc: ``pytest_ignore_collect``, ``pytest_collect_directory``, ``pytest_collect_file`` and ``pytest_pycollect_makemodule`` hooks's 'path' parameter documented type is now ``py.path.local``

11
src/_pytest/hookspec.py
View File

@ -188,7 +188,7 @@ def pytest_ignore_collect(path, config):
Stops at first non-None result, see :ref:`firstresult` 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 :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` 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 """ return collection Node or None for the given path. Any new node
needs to have the specified ``parent`` as a parent. 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 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. 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) @hookspec(firstresult=True)