From 7445b5345f22c2cf0072326f89f09a1e8bfec54f Mon Sep 17 00:00:00 2001 From: Holger Kohr Date: Wed, 6 Feb 2019 21:51:05 +0100 Subject: [PATCH] Mention that `pytest_plugins` should not be used as module name --- changelog/3899.doc.rst | 1 + doc/en/plugins.rst | 5 +++++ 2 files changed, 6 insertions(+) create mode 100644 changelog/3899.doc.rst diff --git a/changelog/3899.doc.rst b/changelog/3899.doc.rst new file mode 100644 index 000000000..675684a01 --- /dev/null +++ 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 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 ` 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