Skip to content

Commit

Permalink
Merge branch 'file-plugin-docs' into 'master'
Browse files Browse the repository at this point in the history
Update documentation to separate parameter types

This is the documentation update separated from !80 which should be pretty uncontroversial. I already applied the comment on the documentation here.

See merge request !83
  • Loading branch information
sigmavirus24 committed Jul 25, 2016
2 parents fc035c4 + 3191c44 commit 232ef0e
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions docs/source/plugin-development/plugin-parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,25 @@ a file, a plugin can ask for any of the following:
- :attr:`~flake8.processor.FileProcessor.indent_level`
- :attr:`~flake8.processor.FileProcessor.line_number`
- :attr:`~flake8.processor.FileProcessor.logical_line`
- :attr:`~flake8.processor.FileProcessor.max_line_length`
- :attr:`~flake8.processor.FileProcessor.multiline`
- :attr:`~flake8.processor.FileProcessor.noqa`
- :attr:`~flake8.processor.FileProcessor.previous_indent_level`
- :attr:`~flake8.processor.FileProcessor.previous_logical`
- :attr:`~flake8.processor.FileProcessor.tokens`

Some properties are set once per file being processed:

- :attr:`~flake8.processor.FileProcessor.filename`
- :attr:`~flake8.processor.FileProcessor.lines`
- :attr:`~flake8.processor.FileProcessor.max_line_length`
- :attr:`~flake8.processor.FileProcessor.total_lines`
- :attr:`~flake8.processor.FileProcessor.verbose`

Alternatively, a plugin can accept ``tree`` and ``filename``.
``tree`` will be a parsed abstract syntax tree that will be used by plugins
like PyFlakes and McCabe.
These parameters can also be supplied to plugins working on each line
separately. Additionally, plugins called once per file can also accept ``tree``
which is not supplied as a parameter of
:class:`~flake8.processor.FileProcessor`, which will be a parsed abstract
syntax tree. It is used by plugins like PyFlakes and McCabe.


Registering Options
Expand Down

0 comments on commit 232ef0e

Please sign in to comment.