pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-03-30 18:56:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'entry_point_docs_update' into 'master'

Browse source 
add common entry points and instruction to docs

See merge request pycqa/flake8!229
This commit is contained in:
Ian Stapleton Cordasco 2018-04-15 19:26:49 +00:00
commit 730071cdaf
1 changed files with 9 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/source/plugin-development/registering-plugins.rst
View file

@ -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