summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-05-06 23:19:54 +0100
committerw0rp <devw0rp@gmail.com>2017-05-06 23:19:54 +0100
commita9c5e14fc99dd5458e20849822647f9982386adc (patch)
treed731073c7031c6ae1110995df2a6a14fc2a1e15f /doc
parent702b203c5165bbdeb1279b1198d3f0389c5ada69 (diff)
downloadale-a9c5e14fc99dd5458e20849822647f9982386adc.zip
Fix #363 - Detect virtualenv executables and fix import paths for mypy. Use lint_file for mypy
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-python.txt28
1 files changed, 25 insertions, 3 deletions
diff --git a/doc/ale-python.txt b/doc/ale-python.txt
index 6b4a4ea4..00aa9b38 100644
--- a/doc/ale-python.txt
+++ b/doc/ale-python.txt
@@ -34,6 +34,14 @@ g:ale_python_flake8_options *g:ale_python_flake8_options*
-------------------------------------------------------------------------------
mypy *ale-python-mypy*
+g:ale_python_mypy_executable *g:ale_python_mypy_executable*
+ *b:ale_python_mypy_executable*
+ Type: |String|
+ Default: `'mypy'`
+
+ This variable can be changed to modify the executable used for mypy.
+
+
g:ale_python_mypy_options *g:ale_python_mypy_options*
*b:ale_python_mypy_options*
Type: |String|
@@ -43,6 +51,18 @@ g:ale_python_mypy_options *g:ale_python_mypy_options*
invocation.
+g:ale_python_mypy_use_global *g:ale_python_mypy_use_global*
+ *b:ale_python_mypy_use_global*
+ Type: |Number|
+ Default: `0`
+
+ This variable controls whether or not ALE will search for mypy in a
+ virtualenv directory first. If this variable is set to `1`, then ALE will
+ always use |g:ale_python_mypy_executable| for the executable path.
+
+ Both variables can be set with `b:` buffer variables instead.
+
+
-------------------------------------------------------------------------------
pylint *ale-python-pylint*
@@ -67,6 +87,8 @@ g:ale_python_pylint_options *g:ale_python_pylint_options*
let g:ale_python_pylint_executable = 'python3' " or 'python' for Python 2
let g:ale_python_pylint_options = '-rcfile /path/to/pylint.rc'
+ " The virtualenv detection needs to be disabled.
+ let g:ale_python_pylint_use_global = 0
after making sure it's installed for the appropriate Python versions (e.g.
`python3 -m pip install --user pylint`).
@@ -77,9 +99,9 @@ g:ale_python_pylint_use_global *g:ale_python_pylint_use_global*
Type: |Number|
Default: `0`
- This variable controls whether or not ALE will search pylint in a virtualenv
- directory first. If this variable is set to `1`, then ALE will always use
- |g:ale_python_pylint_executable| for the executable path.
+ This variable controls whether or not ALE will search for pylint in a
+ virtualenv directory first. If this variable is set to `1`, then ALE will
+ always use |g:ale_python_pylint_executable| for the executable path.
Both variables can be set with `b:` buffer variables instead.