diff options
| author | Ian Cordasco <graffatcolmingov@gmail.com> | 2016-07-27 00:45:31 +0000 |
|---|---|---|
| committer | Ian Cordasco <graffatcolmingov@gmail.com> | 2016-07-27 00:45:31 +0000 |
| commit | 0e8d7cb7e209ed0f49317b5abcd411de012c7ee8 (patch) | |
| tree | b8c490d3177a3051d2277e137eaf1f41ced0de38 /docs/source | |
| parent | e51fc5458b81b6c56c359c79b13ce88b70e476ec (diff) | |
| parent | 9f10219137673fb2ec1afb0d282dc43ea21d9198 (diff) | |
| download | flake8-0e8d7cb7e209ed0f49317b5abcd411de012c7ee8.tar.gz | |
Merge branch 'entry-point' into 'master'
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
Diffstat (limited to 'docs/source')
| -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 |