summaryrefslogtreecommitdiff
path: root/doc/ale-python.txt
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-06-18 11:03:31 +0100
committerw0rp <devw0rp@gmail.com>2017-06-18 11:03:31 +0100
commit629ff513ec09cc5db24d493abe125cc71e89e54e (patch)
treedbde1150b7bae5ab296c6e8efb2e92cae1692fd9 /doc/ale-python.txt
parentfb682be1997f812171def14976b5dfbef38c9f0d (diff)
downloadale-629ff513ec09cc5db24d493abe125cc71e89e54e.zip
#659 - Add options for Python fixers, and cut down on duplicated documentation
Diffstat (limited to 'doc/ale-python.txt')
-rw-r--r--doc/ale-python.txt79
1 files changed, 68 insertions, 11 deletions
diff --git a/doc/ale-python.txt b/doc/ale-python.txt
index 26e1d71a..ddbe9e3a 100644
--- a/doc/ale-python.txt
+++ b/doc/ale-python.txt
@@ -18,6 +18,33 @@ g:ale_virtualenv_dir_names *g:ale_virtualenv_dir_names*
-------------------------------------------------------------------------------
+autopep8 *ale-python-autopep8*
+
+g:ale_python_autopep8_executable *g:ale_python_autopep8_executable*
+ *b:ale_python_autopep8_executable*
+ Type: |String|
+ Default: `'autopep8'`
+
+ See |ale-integrations-local-executables|
+
+
+g:ale_python_autopep8_options *g:ale_python_autopep8_options*
+ *b:ale_python_autopep8_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass extra options to autopep8.
+
+
+g:ale_python_autopep8_use_global *g:ale_python_autopep8_use_global*
+ *b:ale_python_autopep8_use_global*
+ Type: |Number|
+ Default: `0`
+
+ See |ale-integrations-local-executables|
+
+
+-------------------------------------------------------------------------------
flake8 *ale-python-flake8*
g:ale_python_flake8_executable *g:ale_python_flake8_executable*
@@ -59,6 +86,25 @@ g:ale_python_flake8_use_global *g:ale_python_flake8_use_global*
-------------------------------------------------------------------------------
+isort *ale-python-isort*
+
+g:ale_python_isort_executable *g:ale_python_isort_executable*
+ *b:ale_python_isort_executable*
+ Type: |String|
+ Default: `'isort'`
+
+ See |ale-integrations-local-executables|
+
+
+g:ale_python_isort_use_global *g:ale_python_isort_use_global*
+ *b:ale_python_isort_use_global*
+ Type: |Number|
+ Default: `0`
+
+ See |ale-integrations-local-executables|
+
+
+-------------------------------------------------------------------------------
mypy *ale-python-mypy*
g:ale_python_mypy_executable *g:ale_python_mypy_executable*
@@ -66,7 +112,7 @@ g:ale_python_mypy_executable *g:ale_python_mypy_executable*
Type: |String|
Default: `'mypy'`
- This variable can be changed to modify the executable used for mypy.
+ See |ale-integrations-local-executables|
g:ale_python_mypy_options *g:ale_python_mypy_options*
@@ -83,11 +129,7 @@ g:ale_python_mypy_use_global *g: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.
+ See |ale-integrations-local-executables|
-------------------------------------------------------------------------------
@@ -98,7 +140,7 @@ g:ale_python_pylint_executable *g:ale_python_pylint_executable*
Type: |String|
Default: `'pylint'`
- This variable can be changed to modify the executable used for pylint.
+ See |ale-integrations-local-executables|
g:ale_python_pylint_options *g:ale_python_pylint_options*
@@ -126,11 +168,26 @@ 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 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.
+ See |ale-integrations-local-executables|
- Both variables can be set with `b:` buffer variables instead.
+
+-------------------------------------------------------------------------------
+yapf *ale-python-yapf*
+
+g:ale_python_yapf_executable *g:ale_python_yapf_executable*
+ *b:ale_python_yapf_executable*
+ Type: |String|
+ Default: `'yapf'`
+
+ See |ale-integrations-local-executables|
+
+
+g:ale_python_yapf_use_global *g:ale_python_yapf_use_global*
+ *b:ale_python_yapf_use_global*
+ Type: |Number|
+ Default: `0`
+
+ See |ale-integrations-local-executables|
-------------------------------------------------------------------------------