Merge pull request #4735 from kohr-h/pytest_plugins_module_name

Mention that `pytest_plugins` should not be used as module name
This commit is contained in:
Ronny Pfannschmidt 2019-02-07 07:07:58 +01:00 committed by GitHub
commit 526f4a95cc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 0 deletions

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.

View File

@ -84,6 +84,11 @@ will be loaded as well.
:ref:`full explanation <requiring plugins in non-root conftests>`
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`:
Finding out which plugins are active