diff options
| author | Fabian Neundorf <CommodoreFabianus@gmx.de> | 2016-07-26 15:57:51 +0000 |
|---|---|---|
| committer | Fabian Neundorf <CommodoreFabianus@gmx.de> | 2016-07-26 17:57:51 +0200 |
| commit | 9f10219137673fb2ec1afb0d282dc43ea21d9198 (patch) | |
| tree | afa17ddc62c474fb3454c746af994a63690df44b /docs/source/plugin-development/registering-plugins.rst | |
| parent | 99602828c7b91a05b1f33603131ebf20f110a33f (diff) | |
| download | flake8-9f10219137673fb2ec1afb0d282dc43ea21d9198.tar.gz | |
Clarify what the X in the entry points does
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
Diffstat (limited to 'docs/source/plugin-development/registering-plugins.rst')
| -rw-r--r-- | docs/source/plugin-development/registering-plugins.rst | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/source/plugin-development/registering-plugins.rst b/docs/source/plugin-development/registering-plugins.rst index 76ed8af..1974225 100644 --- a/docs/source/plugin-development/registering-plugins.rst +++ b/docs/source/plugin-development/registering-plugins.rst @@ -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 |