Merge pull request #4735 from kohr-h/pytest_plugins_module_name

RonnyPfannschmidt · web-flow · commit 526f4a95cc58 · 2019-02-07T07:07:58.000+01:00
Mention that `pytest_plugins` should not be used as module name
diff --git a/changelog/3899.doc.rst b/changelog/3899.doc.rst
@@ -0,0 +1 @@
+Add note to ``plugins.rst`` that ``pytest_plugins`` should not be used as a name for a user module containing plugins.
diff --git a/doc/en/plugins.rst b/doc/en/plugins.rst
@@ -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

Original file line number	Diff line number	Diff 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.