summaryrefslogtreecommitdiff
path: root/doc/ale-python.txt
diff options
context:
space:
mode:
authorHolden <holden@axoni.com>2018-12-07 18:05:20 -0500
committerHolden <holden@axoni.com>2018-12-07 18:05:20 -0500
commit57a04701c3ac1d06efbf16f2ce184c37f0076d16 (patch)
tree8181c0025e95cd941e6abe20b45f579e1f783c08 /doc/ale-python.txt
parentcbc029b2b832e6d70d95e6cf810ab6252b42e643 (diff)
parent9226e13b31474ac17d0c25cd27aa55bff21d55c2 (diff)
downloadale-57a04701c3ac1d06efbf16f2ce184c37f0076d16.zip
Merge branch 'master' of github.com:stegmanh/ale
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*