summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorYauhen Kirylau <actionless.loveless@gmail.com>2018-07-26 09:41:27 +0200
committerw0rp <w0rp@users.noreply.github.com>2018-07-26 08:41:27 +0100
commit8517e901ffff5dbc4928cba64f30c26d08869733 (patch)
tree625bdb0d89b8d0778cf774176965c59f49fb86ce /doc
parent79ffdde267323a206a96227904549c370f27decf (diff)
downloadale-8517e901ffff5dbc4928cba64f30c26d08869733.zip
Add support for 'vulture' for Python
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-python.txt30
-rw-r--r--doc/ale.txt3
2 files changed, 32 insertions, 1 deletions
diff --git a/doc/ale-python.txt b/doc/ale-python.txt
index e24ef1aa..093ea758 100644
--- a/doc/ale-python.txt
+++ b/doc/ale-python.txt
@@ -398,6 +398,36 @@ g:ale_python_pyre_use_global *g:ale_python_pyre_use_global*
===============================================================================
+vulture *ale-python-vulture*
+
+g:ale_python_vulture_change_directory *g:ale_python_vulture_change_directory*
+ *b:ale_python_vulture_change_directory*
+ Type: |Number|
+ Default: `1`
+
+ If set to `1`, ALE will switch to the directory the Python file being
+ checked with `vulture` is in before checking it and check the whole project
+ directory instead of checking only the file opened in the current buffer.
+ This helps `vulture` to know the context and avoid false-negative results.
+
+
+g:ale_python_vulture_executable *g:ale_python_vulture_executable*
+ *b:ale_python_vulture_executable*
+ Type: |String|
+ Default: `'vulture'`
+
+ See |ale-integrations-local-executables|
+
+
+g:ale_python_vulture_use_global *g:ale_python_vulture_use_global*
+ *b:ale_python_vulture_use_global*
+ Type: |Number|
+ Default: `get(g:, 'ale_use_global_executables', 0)`
+
+ See |ale-integrations-local-executables|
+
+
+===============================================================================
yapf *ale-python-yapf*
g:ale_python_yapf_executable *g:ale_python_yapf_executable*
diff --git a/doc/ale.txt b/doc/ale.txt
index fdb2d0a6..24f57424 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -207,6 +207,7 @@ CONTENTS *ale-contents*
pylint..............................|ale-python-pylint|
pyls................................|ale-python-pyls|
pyre................................|ale-python-pyre|
+ vulture.............................|ale-python-vulture|
yapf................................|ale-python-yapf|
qml...................................|ale-qml-options|
qmlfmt..............................|ale-qml-qmlfmt|
@@ -399,7 +400,7 @@ Notes:
* proto: `protoc-gen-lint`
* Pug: `pug-lint`
* Puppet: `languageserver`, `puppet`, `puppet-lint`
-* Python: `autopep8`, `black`, `flake8`, `isort`, `mypy`, `prospector`, `pycodestyle`, `pyls`, `pyre`, `pylint`!!, `yapf`
+* Python: `autopep8`, `black`, `flake8`, `isort`, `mypy`, `prospector`, `pycodestyle`, `pyls`, `pyre`, `pylint`!!, `vulture`, `yapf`
* QML: `qmlfmt`, `qmllint`
* R: `lintr`
* ReasonML: `merlin`, `ols`, `refmt`