summaryrefslogtreecommitdiff
path: root/docs/source/plugin-development/registering-plugins.rst
diff options
context:
space:
mode:
authorIan Cordasco <graffatcolmingov@gmail.com>2016-07-26 19:49:36 -0500
committerIan Cordasco <graffatcolmingov@gmail.com>2016-07-26 19:49:36 -0500
commit12dcb10c90d8bd1458a004a75d98d0478f869dc8 (patch)
tree8581805bc09101d0170d442f70375b9baa496ed4 /docs/source/plugin-development/registering-plugins.rst
parent0e8d7cb7e209ed0f49317b5abcd411de012c7ee8 (diff)
downloadflake8-12dcb10c90d8bd1458a004a75d98d0478f869dc8.tar.gz
Make the documentation very obvious
Diffstat (limited to 'docs/source/plugin-development/registering-plugins.rst')
-rw-r--r--docs/source/plugin-development/registering-plugins.rst19
1 files changed, 17 insertions, 2 deletions
diff --git a/docs/source/plugin-development/registering-plugins.rst b/docs/source/plugin-development/registering-plugins.rst
index 1974225..0f4280f 100644
--- a/docs/source/plugin-development/registering-plugins.rst
+++ b/docs/source/plugin-development/registering-plugins.rst
@@ -112,8 +112,23 @@ like:
)
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``.
+So if the plugin reports only the error code ``X101`` your entry-point would
+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: