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

Make the documentation very obvious

Browse source
This commit is contained in:
Ian Cordasco 2016-07-26 19:49:36 -05:00
parent 0e8d7cb7e2
commit 12dcb10c90
No known key found for this signature in database
GPG key ID: 656D3395E4A9791A
1 changed files with 17 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -112,8 +112,23 @@ like:
) )
The ``X`` in checking plugins define what error codes it is going to report. 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 So if the plugin reports only the error code ``X101`` your entry-point would
reports also ``A102`` it must be set to ``A10``. look like::
X101 = flake8_example.ExamplePlugin
If your plugin reports several error codes that all start with ``X10``, then
it would look like::
X10 = flake8_example.ExamplePlugin
If all of your plugin's error codes start with ``X1`` then it would look
like::
X1 = flake8_example.ExamplePlugin
Finally, if all of your plugin's error codes start with just ``X`` then it
would look like the original example.
.. _Entry Points: .. _Entry Points: