Commit graph

18 commits

Author SHA1 Message Date
Tyler Wince
a7c0fc6463 added language for entry point length 2018-03-30 14:46:14 -07:00
Tyler Wince
8e7658c06d add common entry points and instruction to docs 2018-03-29 08:09:07 -07:00
Jon Dufresne
96841cd41d Drop from __future__ import with_statement from docs
All versions of Python that flake8 supports (2.7, 3.4+) have full
support for the with statement. There is no need to add the import.

Slightly simplifies the example be removing unnecessary boilerplate.
2017-11-26 09:58:55 -08:00
Yen Chi Hsuan
6595d3a08d Add previous_unindented_logical_line attribute
This attribute is introduced in pycodestyle 2.1.0

Closes #246

See: https://github.com/PyCQA/pycodestyle/issues/400
2016-11-08 23:34:56 +08:00
Ian Cordasco
1cfc12f366
Trim trailing spaces from documentation 2016-10-25 12:01:43 -05:00
Ian Cordasco
91a1ce47d6
Merge branch 'file-tokens' of xzise/flake8 2016-10-25 11:57:24 -05:00
Fabian Neundorf
eae68a41f6 Document how it determines when the plugin is run
If a plugin's target (constructor or function) doesn't satisfy specific
parameters, it'll never be called. This documents what the parameters must
contain to be run at all.

Related to: #159
2016-08-01 14:06:33 +02:00
Ian Cordasco
12dcb10c90
Make the documentation very obvious 2016-07-26 19:49:36 -05:00
Fabian Neundorf
9f10219137 Clarify what the X in the entry points does
Previously the `X` wasn't further explained in the documentation on how to
register a plugin. This plugs the hole at least for checking plugins.

See also: #183
2016-07-26 17:57:51 +02:00
Fabian Neundorf
3191c44cfc Update documentation to separate parameter types
It updates the documentation to separate which parameters are static and
which are changed on each line. Using the latter parameters on plugins which
are only run once per file isn't very sensible.
2016-07-25 15:45:44 +02:00
Fabian Neundorf
9cf8603e94 Add support for tokens of a complete file
The `tokens` property of the `FileProcessor` class only contains tokens of the
current line but not all tokens. So if a plugin which is only executed once
per file, that property is useless. To make the tokens also available to
plugins it is now be able to supply all the tokens of a file.

It also updates the documentation to separate which parameters are static and
which are changed on each line. Using the latter parameters on plugins which
are only run once per file isn't very sensible.
2016-07-22 00:28:23 +02:00
Fabian Neundorf
965d6f9509 Fix typo in documentation using indect
The documentation for the `FileProcessor` class used `indect_char` while the
class itself uses the more sensible name `indent_char`. This updates both the
docstring as well as the documentation.
2016-07-21 13:59:07 +02:00
Ian Cordasco
8a2e7ff908
Trim trailing whitespace in compat docs 2016-07-20 08:17:33 -05:00
Ian Cordasco
370912988f
Document flake8-polyfill in compatibility section
Yesterday we released the flake8-polyfill package to help with Flake8
compatibility issues. This adds documentation to Flake8 to help people
use that and to guide them towards it.
2016-07-20 08:12:45 -05:00
Ian Cordasco
469da96001
Add new Flake8 classifier to Trove list 2016-07-09 16:16:07 -05:00
Fabian Neundorf
fabb13c5d1 Use option name provided by the parser
When calling `add_option` it returns an `Option` object which can return the
primary name of the option via `get_opt_name`. This should be used primarily
in the cross compatible implementation so that the order of parameters does
not matter.
2016-07-09 21:27:19 +02:00
Ian Cordasco
5a9b7c27ab
Update compatibility docs 2016-06-26 06:41:47 -05:00
Ian Cordasco
5c8d767626
Rename dev subdirectory to plugin-development
This should make the contents clearer
2016-06-25 09:51:15 -05:00