summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorKonstantin Alekseev <mail@kalekseev.com>2019-10-22 00:38:54 +0300
committerKonstantin Alekseev <mail@kalekseev.com>2020-08-30 22:56:10 +0300
commit1462de6685d7d71b7adba9f1b5e4f568b40da6b1 (patch)
tree607422568e1454ee37825782a2cc617f4597986a /doc
parent0989da4a38c80983548db623d407d7178f2452d5 (diff)
downloadale-1462de6685d7d71b7adba9f1b5e4f568b40da6b1.zip
Run flake8 from project root by default.
Option `per-file-ignores` was introduced in flake8 version 3.7.0. It allows to ignore specific errors in specific files using glob syntax. For example `per-file-ignores = src/generated/*.py:F401` will ignore `F401` error in all python files in `src/generated`. Thus ale has to run flake8 from project root where .flake8 config is placed otherwise glob won't match linted file.
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-python.txt13
1 files changed, 7 insertions, 6 deletions
diff --git a/doc/ale-python.txt b/doc/ale-python.txt
index 60b0771d..6b1a6d33 100644
--- a/doc/ale-python.txt
+++ b/doc/ale-python.txt
@@ -169,13 +169,14 @@ flake8 *ale-python-flake8*
g:ale_python_flake8_change_directory *g:ale_python_flake8_change_directory*
*b:ale_python_flake8_change_directory*
- Type: |Number|
- Default: `1`
+ Type: |String|
+ Default: `project`
- If set to `1`, ALE will switch to the directory the Python file being
- checked with `flake8` is in before checking it. This helps `flake8` find
- configuration files more easily. This option can be turned off if you want
- to control the directory Python is executed from yourself.
+ If set to `project`, ALE will switch to the project root before checking file.
+ If set to `file`, ALE will switch to directory the Python file being
+ checked with `flake8` is in before checking it.
+ You can turn it off with `off` option if you want to control the directory
+ Python is executed from yourself.
g:ale_python_flake8_executable *g:ale_python_flake8_executable*