Skip to content

Commit

Permalink
docs: be more explicit about module level skip preventing collection
Browse files Browse the repository at this point in the history
  • Loading branch information
RonnyPfannschmidt committed Feb 19, 2023
1 parent da626e7 commit e839ee6
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions src/_pytest/outcomes.py
Expand Up @@ -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.
Expand Down

0 comments on commit e839ee6

Please sign in to comment.