summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorIan Stapleton Cordasco <graffatcolmingov@gmail.com>2018-04-15 19:26:49 +0000
committerIan Stapleton Cordasco <graffatcolmingov@gmail.com>2018-04-15 19:26:49 +0000
commit730071cdafcf73346ee11b222cbf66dcc84645c9 (patch)
tree9f00d606dce7def68f662c39716d9b36a9260576 /docs
parent4057d3d3cca7d39f084ba0d1ec538795e319f2f8 (diff)
parent7635db1ce3fc3c7471d6003ccb632a145c3d08e6 (diff)
downloadflake8-730071cdafcf73346ee11b222cbf66dcc84645c9.tar.gz
Merge branch 'entry_point_docs_update' into 'master'
add common entry points and instruction to docs See merge request pycqa/flake8!229
Diffstat (limited to 'docs')
-rw-r--r--docs/source/plugin-development/registering-plugins.rst10
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/source/plugin-development/registering-plugins.rst b/docs/source/plugin-development/registering-plugins.rst
index d18d2fa..851a9e7 100644
--- a/docs/source/plugin-development/registering-plugins.rst
+++ b/docs/source/plugin-development/registering-plugins.rst
@@ -129,6 +129,14 @@ like::
Finally, if all of your plugin's error codes start with just ``X`` then it
would look like the original example.
+|Flake8| requires each entry point to be unique amongst all plugins installed
+in the users environment. Selecting an entry point that is already used can
+cause plugins to be deactivated without warning!
+
+**Please Note:** Your entry point does not need to be exactly 4 characters
+as of |Flake8| 3.0. *Consider using an entry point with 3 letters followed
+by 3 numbers (i.e.* ``ABC123`` *).*
+
.. _Entry Points:
- https://pythonhosted.org/setuptools/pkg_resources.html#entry-points
+ http://setuptools.readthedocs.io/en/latest/pkg_resources.html#entry-points