summaryrefslogtreecommitdiff
path: root/doc/extend.rst
diff options
context:
space:
mode:
authorClaudiu Popa <cpopa@cloudbasesolutions.com>2014-11-12 22:26:04 +0200
committerClaudiu Popa <cpopa@cloudbasesolutions.com>2014-11-12 22:26:04 +0200
commitaf213f498b2ec2fea079cef508135949b724ceaf (patch)
tree01cefc93ff9855ff777b028d2f9814f97fda34d9 /doc/extend.rst
parent29ee4406d2ad7ee222be1673f5e675267c123c09 (diff)
downloadpylint-af213f498b2ec2fea079cef508135949b724ceaf.tar.gz
Cleanup through documentation.
Diffstat (limited to 'doc/extend.rst')
-rw-r--r--doc/extend.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/extend.rst b/doc/extend.rst
index 476c994..b767852 100644
--- a/doc/extend.rst
+++ b/doc/extend.rst
@@ -8,7 +8,8 @@ You can find some simple examples in the examples
directory of the distribution (custom.py and custom_raw.py). I'll try to
quickly explain the essentials here.
-First, there are two kinds of checkers :
+First, there are two kinds of checkers:
+
* raw checkers, which are analysing each module as a raw file stream
* ast checkers, which are working on an ast representation of the module
@@ -25,8 +26,8 @@ Checkers are ordered by priority. For each module, Pylint's engine:
1. give the module source file as a stream to raw checkers
2. get an ast representation for the module
-3. make a depth first descent of the tree, calling visit_<> on each AST
- checker when entering a node, and living_<> on the back traversal
+3. make a depth first descent of the tree, calling ``visit_<>`` on each AST
+ checker when entering a node, and ``leave_<>`` on the back traversal
Notice that the source code is probably the best source of
documentation, it should be clear and well documented. Don't hesitate to