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

Mention that `pytest_plugins` should not be used as module name

This commit is contained in:
Holger Kohr 2019-02-06 21:51:05 +01:00
parent 36f6687b70
commit 7445b5345f
2 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -0,0 +1 @@
Add note to ``plugins.rst`` that ``pytest_plugins`` should not be used as a name for a user module containing plugins.

5
doc/en/plugins.rst
View File

@ -86,6 +86,11 @@ which will import the specified module as a ``pytest`` plugin.
:ref:`full explanation <requiring plugins in non-root conftests>` :ref:`full explanation <requiring plugins in non-root conftests>`
in the Writing plugins section. in the Writing plugins section.
.. note::
The name ``pytest_plugins`` is reserved and should not be used as a
name for a custom plugin module.
.. _`findpluginname`: .. _`findpluginname`:
Finding out which plugins are active Finding out which plugins are active