summaryrefslogtreecommitdiff
path: root/doc/ale-python.txt
diff options
context:
space:
mode:
authorpmacosta <pmacosta@users.noreply.github.com>2018-12-06 13:27:03 -0500
committerBjorn Neergaard <bjorn@neersighted.com>2018-12-06 11:27:03 -0700
commitfdd37acc1f381230fc2ed87303e98c7a4daafaad (patch)
treef7e139d3f7c3d7c3b683efa1fd8f0171cd647f75 /doc/ale-python.txt
parent2760cf7018893b42c4ae5c750a7f1d38669aa821 (diff)
downloadale-fdd37acc1f381230fc2ed87303e98c7a4daafaad.zip
Add support for pydocstyle linter (#2085)
The linter can correctly parse pydocstyle output with any of the following command-line options enabled: --explain, --source, --debug, and/or --verbose
Diffstat (limited to 'doc/ale-python.txt')
-rw-r--r--doc/ale-python.txt40
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/ale-python.txt b/doc/ale-python.txt
index 0b8e1746..f3f2801a 100644
--- a/doc/ale-python.txt
+++ b/doc/ale-python.txt
@@ -329,6 +329,46 @@ g:ale_python_pycodestyle_auto_pipenv *g:ale_python_pycodestyle_auto_pipenv*
===============================================================================
+pydocstyle *ale-python-pydocstyle*
+
+
+g:ale_python_pydocstyle_executable *g:ale_python_pydocstyle_executable*
+ *b:ale_python_pydocstyle_executable*
+ Type: |String|
+ Default: `'pydocstyle'`
+
+ See |ale-integrations-local-executables|
+
+ Set this to `'pipenv'` to invoke `'pipenv` `run` `pydocstyle'`.
+
+
+g:ale_python_pydocstyle_options *g:ale_python_pydocstyle_options*
+ *b:ale_python_pydocstyle_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be changed to add command-line arguments to the
+ pydocstyle invocation.
+
+
+g:ale_python_pydocstyle_use_global *g:ale_python_pydocstyle_use_global*
+ *b:ale_python_pydocstyle_use_global*
+ Type: |Number|
+ Default: `get(g:, 'ale_use_global_executables', 0)`
+
+ See |ale-integrations-local-executables|
+
+
+g:ale_python_pydocstyle_auto_pipenv *g:ale_python_pydocstyle_auto_pipenv*
+ *b:ale_python_pydocstyle_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*