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

Clarify what the X in the entry points does

Browse source 
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.

See also: #183
This commit is contained in:
Fabian Neundorf 2016-07-26 15:57:51 +00:00
parent 99602828c7
commit 9f10219137
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 ...
)
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.
|Flake8| presently looks at three groups:
@ -111,6 +111,10 @@ like:
# 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:
https://pythonhosted.org/setuptools/pkg_resources.html#entry-points