Skip to content

Commit

Permalink
Merge branch 'entry-point' into 'master'
Browse files Browse the repository at this point in the history
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
  • Loading branch information
sigmavirus24 committed Jul 27, 2016
2 parents e51fc54 + 9f10219 commit 0e8d7cb
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/source/plugin-development/registering-plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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

0 comments on commit 0e8d7cb

Please sign in to comment.