summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMarius Gedminas <marius@gedmin.as>2016-11-14 19:52:31 +0200
committerw0rp <w0rp@users.noreply.github.com>2016-11-14 17:52:31 +0000
commit713a6910d40466c34ec5622770c6b7a6cae1d007 (patch)
tree30de2cd68288396779ab71b699312df2c8283b63 /doc
parent498a9435dec6c0f9f945bcada3e6409ab9e81a7b (diff)
downloadale-713a6910d40466c34ec5622770c6b7a6cae1d007.zip
Add g:ale_python_flake8_executable (#174)
* Add g:ale_python_flake8_executable Closes #172. * Add g:ale_python_flake8_args * Always add - to flake8 invocations
Diffstat (limited to 'doc')
-rw-r--r--doc/ale.txt28
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/ale.txt b/doc/ale.txt
index 52aa796c..137d433d 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -598,6 +598,34 @@ g:ale_c_clang_options *g:ale_c_clang_options*
This variable can be change to modify flags given to clang.
+-------------------------------------------------------------------------------
+4.17. python-flake8 *ale-linter-options-python-flake8*
+
+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.
+
+
+g:ale_python_flake8_args *g:ale_python_flake8_args*
+
+ Type: |String|
+ Default: `''`
+
+ This variable can be changed to add command-line arguments to the flake8
+ invocation.
+
+For example, to dynamically switch between programs targeting Python 2 and
+Python 3, you may want to set >
+
+ let g:ale_python_flake8_executable = 'python3' " or 'python' for Python 2
+ let g:ale_python_flake8_args = '-m flake8'
+
+after making sure it's installed for the appropriate Python versions (e.g.
+`python3 -m pip install --user flake8`).
+
===============================================================================
5. Commands/Keybinds *ale-commands*