summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBryce Guinta <bryce.paul.guinta@gmail.com>2017-10-10 21:10:05 -0600
committerClaudiu Popa <pcmanticore@gmail.com>2017-10-12 09:22:51 +0200
commitaf79045faaac93aa9f3dda29ba8e54b7bc74ee1f (patch)
tree34fe6302df3292170939935074056fe22e9c6432 /doc
parentd7761264e6c409067d9e73d067c51e3c40d77d13 (diff)
downloadpylint-git-af79045faaac93aa9f3dda29ba8e54b7bc74ee1f.tar.gz
Explain how to make a plugin findable by pylint
Diffstat (limited to 'doc')
-rw-r--r--doc/how_tos/custom_checkers.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/how_tos/custom_checkers.rst b/doc/how_tos/custom_checkers.rst
index 3ce996704..eb2287988 100644
--- a/doc/how_tos/custom_checkers.rst
+++ b/doc/how_tos/custom_checkers.rst
@@ -228,6 +228,14 @@ we can run pylint with only our checker::
Now we can debug our checker!
+.. Note::
+
+ ``my_plugin`` refers to a module called ``my_plugin.py``.
+ This module can be made available to pylint by putting this
+ module's parent directory in your ``PYTHONPATH``
+ environment variable or by adding the ``my_plugin.py``
+ file to the ``pylint/checkers`` directory if running from source.
+
Testing a Checker
-----------------
Pylint is very well suited to test driven development.