summaryrefslogtreecommitdiff
path: root/doc/ale-python.txt
diff options
context:
space:
mode:
authorBjorn Neergaard <bjorn@neersighted.com>2018-11-29 14:57:35 -0700
committerBjorn Neergaard <bjorn@neersighted.com>2018-11-29 14:57:35 -0700
commitd2b0ae8108b2ee395d4eb43c49d68b322a023a30 (patch)
treebb8145e69bf1bcb8968b29cb1a68c47ceb83674d /doc/ale-python.txt
parentef641dda80f45cb979bc93c2513c6e10cbd8e42a (diff)
parent0a384a49d371838903d8401c5358ec60f3f4266d (diff)
downloadale-d2b0ae8108b2ee395d4eb43c49d68b322a023a30.zip
Merge branch 'master' into sridhars
Diffstat (limited to 'doc/ale-python.txt')
-rw-r--r--doc/ale-python.txt111
1 files changed, 111 insertions, 0 deletions
diff --git a/doc/ale-python.txt b/doc/ale-python.txt
index e24ef1aa..0b8e1746 100644
--- a/doc/ale-python.txt
+++ b/doc/ale-python.txt
@@ -2,6 +2,14 @@
ALE Python Integration *ale-python-options*
+g:ale_python_auto_pipenv *g:ale_python_auto_pipenv*
+ *b:ale_python_auto_pipenv*
+ Type: |Number|
+ Default: `0`
+
+ Detect whether the file is inside a pipenv, and set the executable to `pipenv`
+ if true. This is overridden by a manually-set executable.
+
===============================================================================
ALE Python Project Root Behavior *ale-python-root*
@@ -22,6 +30,7 @@ ALE will look for configuration files with the following filenames. >
mypy.ini
pycodestyle.cfg
flake8.cfg
+ .flake8rc
Pipfile
Pipfile.lock
<
@@ -136,6 +145,15 @@ g:ale_python_flake8_use_global *g:ale_python_flake8_use_global*
Both variables can be set with `b:` buffer variables instead.
+g:ale_python_flake8_auto_pipenv *g:ale_python_flake8_auto_pipenv*
+ *b:ale_python_flake8_auto_pipenv*
+ Type: |Number|
+ Default: `0`
+
+ Detect whether the file is inside a pipenv, and set the executable to `pipenv`
+ if true. This is overridden by a manually-set executable.
+
+
===============================================================================
isort *ale-python-isort*
@@ -210,6 +228,15 @@ g:ale_python_mypy_use_global *g:ale_python_mypy_use_global*
See |ale-integrations-local-executables|
+g:ale_python_mypy_auto_pipenv *g:ale_python_mypy_auto_pipenv*
+ *b:ale_python_mypy_auto_pipenv*
+ Type: |Number|
+ Default: `0`
+
+ Detect whether the file is inside a pipenv, and set the executable to `pipenv`
+ if true. This is overridden by a manually-set executable.
+
+
===============================================================================
prospector *ale-python-prospector*
@@ -252,6 +279,15 @@ g:ale_python_prospector_use_global *g:ale_python_prospector_use_global*
See |ale-integrations-local-executables|
+g:ale_python_prospector_auto_pipenv *g:ale_python_prospector_auto_pipenv*
+ *b:ale_python_prospector_auto_pipenv*
+ Type: |Number|
+ Default: `0`
+
+ Detect whether the file is inside a pipenv, and set the executable to `pipenv`
+ if true. This is overridden by a manually-set executable.
+
+
===============================================================================
pycodestyle *ale-python-pycodestyle*
@@ -283,6 +319,15 @@ g:ale_python_pycodestyle_use_global *g:ale_python_pycodestyle_use_global*
See |ale-integrations-local-executables|
+g:ale_python_pycodestyle_auto_pipenv *g:ale_python_pycodestyle_auto_pipenv*
+ *b:ale_python_pycodestyle_auto_pipenv*
+ Type: |Number|
+ Default: `0`
+
+ Detect whether the file is inside a pipenv, and set the executable to `pipenv`
+ if true. This is overridden by a manually-set executable.
+
+
===============================================================================
pyflakes *ale-python-pyflakes*
@@ -297,6 +342,15 @@ g:ale_python_pyflakes_executable *g:ale_python_pyflakes_executable*
Set this to `'pipenv'` to invoke `'pipenv` `run` `pyflakes'`.
+g:ale_python_pyflakes_auto_pipenv *g:ale_python_pyflakes_auto_pipenv*
+ *b:ale_python_pyflakes_auto_pipenv*
+ Type: |Number|
+ Default: `0`
+
+ Detect whether the file is inside a pipenv, and set the executable to `pipenv`
+ if true. This is overridden by a manually-set executable.
+
+
===============================================================================
pylint *ale-python-pylint*
@@ -349,6 +403,15 @@ g:ale_python_pylint_use_global *g:ale_python_pylint_use_global*
See |ale-integrations-local-executables|
+g:ale_python_pylint_auto_pipenv *g:ale_python_pylint_auto_pipenv*
+ *b:ale_python_pylint_auto_pipenv*
+ Type: |Number|
+ Default: `0`
+
+ Detect whether the file is inside a pipenv, and set the executable to `pipenv`
+ if true. This is overridden by a manually-set executable.
+
+
===============================================================================
pyls *ale-python-pyls*
@@ -373,6 +436,15 @@ g:ale_python_pyls_use_global *g:ale_python_pyls_use_global*
See |ale-integrations-local-executables|
+g:ale_python_pyls_auto_pipenv *g:ale_python_pyls_auto_pipenv*
+ *b:ale_python_pyls_auto_pipenv*
+ Type: |Number|
+ Default: `0`
+
+ Detect whether the file is inside a pipenv, and set the executable to `pipenv`
+ if true. This is overridden by a manually-set executable.
+
+
===============================================================================
pyre *ale-python-pyre*
@@ -397,6 +469,45 @@ g:ale_python_pyre_use_global *g:ale_python_pyre_use_global*
See |ale-integrations-local-executables|
+g:ale_python_pyre_auto_pipenv *g:ale_python_pyre_auto_pipenv*
+ *b:ale_python_pyre_auto_pipenv*
+ Type: |Number|
+ Default: `0`
+
+ Detect whether the file is inside a pipenv, and set the executable to `pipenv`
+ if true. This is overridden by a manually-set executable.
+
+
+===============================================================================
+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*