docs: be more explicit about module level skip preventing collection

pytest-dev · Feb 19, 2023 · 5f83069 · 5f83069
1 parent da626e7
commit 5f83069
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/changelog/10753.doc.rst b/changelog/10753.doc.rst
@@ -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.
diff --git a/src/_pytest/outcomes.py b/src/_pytest/outcomes.py
@@ -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.