Skip to content

Commit 7445b53

Browse files
committed
Mention that pytest_plugins should not be used as module name
1 parent 36f6687 commit 7445b53

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

changelog/3899.doc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add note to ``plugins.rst`` that ``pytest_plugins`` should not be used as a name for a user module containing plugins.

doc/en/plugins.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,11 @@ which will import the specified module as a ``pytest`` plugin.
8686
:ref:`full explanation <requiring plugins in non-root conftests>`
8787
in the Writing plugins section.
8888

89+
.. note::
90+
The name ``pytest_plugins`` is reserved and should not be used as a
91+
name for a custom plugin module.
92+
93+
8994
.. _`findpluginname`:
9095

9196
Finding out which plugins are active

0 commit comments

Comments
 (0)