summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorEddie Lebow <elebow@users.noreply.github.com>2018-06-04 22:43:02 -0400
committerEddie Lebow <elebow@users.noreply.github.com>2018-06-05 00:33:26 -0400
commitca88e67af0dc159bdb78ad9f038d2c9336fb1b71 (patch)
treec170d053015f209714fee82d0b654981e9db45ec /doc
parent5addd3abefdbc828d92386e27dedfa79d39c5d9d (diff)
downloadale-ca88e67af0dc159bdb78ad9f038d2c9336fb1b71.zip
Allow all Python linter executables to be set to `pipenv`.
It appends ` run {linter_name}`, analogously to the Ruby linters when the executable is set to `bundle`
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-python.txt27
-rw-r--r--doc/ale.txt1
2 files changed, 27 insertions, 1 deletions
diff --git a/doc/ale-python.txt b/doc/ale-python.txt
index 55641892..b24b531d 100644
--- a/doc/ale-python.txt
+++ b/doc/ale-python.txt
@@ -100,7 +100,8 @@ g:ale_python_flake8_executable *g:ale_python_flake8_executable*
Type: |String|
Default: `'flake8'`
- This variable can be changed to modify the executable used for flake8.
+ This variable can be changed to modify the executable used for flake8. Set
+ this to `'pipenv'` to invoke `'pipenv` `run` `flake8'`.
g:ale_python_flake8_options *g:ale_python_flake8_options*
@@ -169,6 +170,8 @@ g:ale_python_mypy_executable *g:ale_python_mypy_executable*
See |ale-integrations-local-executables|
+ Set this to `'pipenv'` to invoke `'pipenv` `run` `mypy'`.
+
g:ale_python_mypy_ignore_invalid_syntax
*g:ale_python_mypy_ignore_invalid_syntax*
*b:ale_python_mypy_ignore_invalid_syntax*
@@ -207,6 +210,8 @@ g:ale_python_prospector_executable *g:ale_python_prospector_executable*
See |ale-integrations-local-executables|
+ Set this to `'pipenv'` to invoke `'pipenv` `run` `prospector'`.
+
g:ale_python_prospector_options *g:ale_python_prospector_options*
*b:ale_python_prospector_options*
@@ -248,6 +253,8 @@ g:ale_python_pycodestyle_executable *g:ale_python_pycodestyle_executable*
See |ale-integrations-local-executables|
+ Set this to `'pipenv'` to invoke `'pipenv` `run` `pycodestyle'`.
+
g:ale_python_pycodestyle_options *g:ale_python_pycodestyle_options*
*b:ale_python_pycodestyle_options*
@@ -267,6 +274,20 @@ g:ale_python_pycodestyle_use_global *g:ale_python_pycodestyle_use_global*
===============================================================================
+pyflakes *ale-python-pyflakes*
+
+
+g:ale_python_pyflakes_executable *g:ale_python_pyflakes_executable*
+ *b:ale_python_pyflakes_executable*
+ Type: |String|
+ Default: `'pyflakes'`
+
+ See |ale-integrations-local-executables|
+
+ Set this to `'pipenv'` to invoke `'pipenv` `run` `pyflakes'`.
+
+
+===============================================================================
pylint *ale-python-pylint*
g:ale_python_pylint_change_directory *g:ale_python_pylint_change_directory*
@@ -287,6 +308,8 @@ g:ale_python_pylint_executable *g:ale_python_pylint_executable*
See |ale-integrations-local-executables|
+ Set this to `'pipenv'` to invoke `'pipenv` `run` `pylint'`.
+
g:ale_python_pylint_options *g:ale_python_pylint_options*
*b:ale_python_pylint_options*
@@ -329,6 +352,8 @@ g:ale_python_pyls_executable *g:ale_python_pyls_executable*
See |ale-integrations-local-executables|
+ Set this to `'pipenv'` to invoke `'pipenv` `run` `pyls'`.
+
g:ale_python_pyls_use_global *g:ale_python_pyls_use_global*
*b:ale_python_pyls_use_global*
diff --git a/doc/ale.txt b/doc/ale.txt
index 2d7a5935..66a81f3a 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -190,6 +190,7 @@ CONTENTS *ale-contents*
mypy................................|ale-python-mypy|
prospector..........................|ale-python-prospector|
pycodestyle.........................|ale-python-pycodestyle|
+ pyflakes............................|ale-python-pyflakes|
pylint..............................|ale-python-pylint|
pyls................................|ale-python-pyls|
yapf................................|ale-python-yapf|