Skip to content

Commit

Permalink
Merge branch 'entry_point_docs_update' into 'master'
Browse files Browse the repository at this point in the history
add common entry points and instruction to docs

See merge request pycqa/flake8!229
  • Loading branch information
sigmavirus24 committed Apr 15, 2018
2 parents 4057d3d + 7635db1 commit 730071c
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/source/plugin-development/registering-plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 730071c

Please sign in to comment.