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

Merge branch 'asottile-entry-point-docs-fixup' into 'master'

Browse source 
Fix sample entry points in docs

See merge request pycqa/flake8!320
This commit is contained in:
Anthony Sottile 2019-05-21 00:37:35 +00:00
commit 52e4126e78
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -111,17 +111,17 @@ The ``X`` in checking plugins define what error codes it is going to report.
So if the plugin reports only the error code ``X101`` your entry-point would
look like::
X101 = flake8_example.ExamplePlugin
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
X10 = flake8_example:ExamplePlugin
If all of your plugin's error codes start with ``X1`` then it would look
like::
X1 = flake8_example.ExamplePlugin
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.