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

docs: be more explicit about module level skip preventing collection

This commit is contained in:
Ronny Pfannschmidt 2023-02-19 22:54:37 +01:00
parent da626e7186
commit 5f83069d86
2 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
changelog/10753.doc.rst Normal file
View File

@ -0,0 +1,2 @@
Change wording of the module level skip to be very explicit
about not collecting and not executing the rest of the module.

7
src/_pytest/outcomes.py
View File

@ -157,8 +157,11 @@ def skip(
The message to show the user as reason for the skip.
:param allow_module_level:
Allows this function to be called at module level, skipping the rest
of the module. Defaults to False.
Allows this function to be called at module level.
Raising the skip exception in a module will stop the execution of the module.
Additionally, the module will no longer be collected.
Defaults to False.
:param msg:
Same as ``reason``, but deprecated. Will be removed in a future version, use ``reason`` instead.