summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorIan Lee <IanLee1521@gmail.com>2014-12-14 17:21:09 -0800
committerIan Lee <IanLee1521@gmail.com>2014-12-14 17:21:09 -0800
commitd80fc1241c9a13c6585f65b217cac33f8dc6d2d7 (patch)
tree9d292b466e2b11af010fec125f935a3b7fb1dbf5 /docs
parentc528dbe17fe428854cdbfcf958fcad6df57d82d3 (diff)
parent1ee296bca0fa611d3dbe87c5c5c8009e448d2556 (diff)
downloadpep8-d80fc1241c9a13c6585f65b217cac33f8dc6d2d7.tar.gz
Merge remote-tracking branch 'yole/import-on-top-of-file' into issue304
Diffstat (limited to 'docs')
-rw-r--r--docs/developer.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/developer.rst b/docs/developer.rst
index 7df1734..4725acd 100644
--- a/docs/developer.rst
+++ b/docs/developer.rst
@@ -59,6 +59,12 @@ additional information with extra arguments. All attributes of the
* ``previous_indent_level``: indentation on previous line
* ``previous_logical``: previous logical line
+Check plugins can also maintain per-file state. If you need this, declare
+a parameter named ``checker_state``. You will be passed a dict, which will be
+the same one for all lines in the same file but a different one for different
+files. Each check plugin gets its own dict, so you don't need to worry about
+clobbering the state of other plugins.
+
The docstring of each check function shall be the relevant part of
text from `PEP 8`_. It is printed if the user enables ``--show-pep8``.
Several docstrings contain examples directly from the `PEP 8`_ document.