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

Merge branch 'entry-point' into 'master'

Browse source 
Clarify what the X in the entry points does

*Description of changes*

Previously the `X` wasn't further explained in the documentation on how to
register a plugin. This plugs the hole at least for checking plugins.

*Related to:*  #183

See merge request !93
This commit is contained in:
Ian Cordasco 2016-07-27 00:45:31 +00:00
commit 0e8d7cb7e2
1 changed files with 5 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -80,7 +80,7 @@ Note specifically these lines:
# snip ... # snip ...
) )
We tell setuptools to register our entry point "X" inside the specific We tell setuptools to register our entry point ``X`` inside the specific
grouping of entry-points that flake8 should look in. grouping of entry-points that flake8 should look in.
|Flake8| presently looks at three groups: |Flake8| presently looks at three groups:
@ -111,6 +111,10 @@ like:
# snip ... # snip ...
) )
The ``X`` in checking plugins define what error codes it is going to report.
So if the plugin reports just the error code ``A101`` it would be that. If it
reports also ``A102`` it must be set to ``A10``.
.. _Entry Points: .. _Entry Points:
https://pythonhosted.org/setuptools/pkg_resources.html#entry-points https://pythonhosted.org/setuptools/pkg_resources.html#entry-points