summaryrefslogtreecommitdiff
path: root/doc/en/plugins.rst
diff options
context:
space:
mode:
authorHolger Kohr <ho.kohr@zoho.com>2019-02-06 21:51:05 +0100
committerHolger Kohr <ho.kohr@zoho.com>2019-02-06 21:57:42 +0100
commit7445b5345f22c2cf0072326f89f09a1e8bfec54f (patch)
treec37831dd41e10393e9c548ba8f9de82e06a813ce /doc/en/plugins.rst
parent36f6687b708875c17d7da48e9a91864ff4bfdbc3 (diff)
downloadpytest-7445b5345f22c2cf0072326f89f09a1e8bfec54f.tar.gz
Mention that `pytest_plugins` should not be used as module name
Diffstat (limited to 'doc/en/plugins.rst')
-rw-r--r--doc/en/plugins.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/en/plugins.rst b/doc/en/plugins.rst
index 3d1226d34..c4961d0a4 100644
--- a/doc/en/plugins.rst
+++ b/doc/en/plugins.rst
@@ -86,6 +86,11 @@ which will import the specified module as a ``pytest`` plugin.
: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