From 56976671d0bb9ba5ea725e8aeda3387c402ce938 Mon Sep 17 00:00:00 2001 From: Ian Cordasco Date: Sun, 7 Feb 2016 09:39:19 -0600 Subject: [PATCH] Fix entry-point names and example usage --- docs/source/dev/registering_plugins.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/source/dev/registering_plugins.rst b/docs/source/dev/registering_plugins.rst index c0edf63..48e39fc 100644 --- a/docs/source/dev/registering_plugins.rst +++ b/docs/source/dev/registering_plugins.rst @@ -48,7 +48,7 @@ like: install_requires=requires, entry_points={ flake8_entry_point: [ - 'X = flake8_example.ExamplePlugin', + 'X = flake8_example:ExamplePlugin', ], }, classifiers=[ @@ -73,7 +73,7 @@ Note specifically these lines: # snip ... entry_points={ flake8_entry_point: [ - 'X = flake8_example.ExamplePlugin', + 'X = flake8_example:ExamplePlugin', ], }, # snip ... @@ -86,14 +86,14 @@ Flake8 presently looks at three groups: - ``flake8.extension`` -- ``flake8.format`` +- ``flake8.listen`` - ``flake8.report`` If your plugin is one that adds checks to Flake8, you will use -``flake8.extension``. If your plugin formats the output and provides that to -the user, you will use ``flake8.format``. Finally, if your plugin performs -extra report handling (filtering, etc.) it will use ``flake8.report``. +``flake8.extension``. If your plugin automatically fixes errors in code, you +will use ``flake8.listen``. Finally, if your plugin performs extra report +handling (formatting, filtering, etc.) it will use ``flake8.report``. If our ``ExamplePlugin`` is something that adds checks, our code would look like: @@ -104,7 +104,7 @@ like: # snip ... entry_points={ 'flake8.extension': [ - 'X = flake8_example.ExamplePlugin', + 'X = flake8_example:ExamplePlugin', ], }, # snip ...