diff options
| author | Carlos Coêlho <carlos@vinta.com.br> | 2017-12-01 14:04:30 -0300 |
|---|---|---|
| committer | w0rp <w0rp@users.noreply.github.com> | 2017-12-01 17:04:30 +0000 |
| commit | daee4a4722ab2ddd9490a50de2c4c1f590325aa7 (patch) | |
| tree | 1007c204f4c22958a28c421a9a839cc37018a721 /doc | |
| parent | 948035e13d466d4e9a1a0cd9a1596cc39bde501e (diff) | |
| download | ale-daee4a4722ab2ddd9490a50de2c4c1f590325aa7.zip | |
Add prospector for checking Python code (#1183)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale-python.txt | 40 | ||||
| -rw-r--r-- | doc/ale.txt | 3 |
2 files changed, 42 insertions, 1 deletions
diff --git a/doc/ale-python.txt b/doc/ale-python.txt index a78cb5ac..742a8544 100644 --- a/doc/ale-python.txt +++ b/doc/ale-python.txt @@ -123,6 +123,46 @@ g:ale_python_mypy_use_global *g:ale_python_mypy_use_global* =============================================================================== +prospector *ale-python-prospector* + +g:ale_python_prospector_executable *g:ale_python_prospector_executable* + *b:ale_python_prospector_executable* + Type: |String| + Default: `'prospector'` + + See |ale-integrations-local-executables| + + +g:ale_python_prospector_options *g:ale_python_prospector_options* + *b:ale_python_prospector_options* + Type: |String| + Default: `''` + + This variable can be changed to add command-line arguments to the prospector + invocation. + + For example, to dynamically switch between programs targeting Python 2 and + Python 3, you may want to set > + + let g:ale_python_prospector_executable = 'python3' + " or 'python' for Python 2 + let g:ale_python_prospector_options = '--rcfile /path/to/.prospector.yaml' + " The virtualenv detection needs to be disabled. + let g:ale_python_prospector_use_global = 0 + + after making sure it's installed for the appropriate Python versions (e.g. + `python3 -m pip install --user prospector`). + + +g:ale_python_prospector_use_global *g:ale_python_prospector_use_global* + *b:ale_python_prospector_use_global* + Type: |Number| + Default: `0` + + See |ale-integrations-local-executables| + + +=============================================================================== pycodestyle *ale-python-pycodestyle* diff --git a/doc/ale.txt b/doc/ale.txt index a4ec7272..d39a5c65 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -153,6 +153,7 @@ CONTENTS *ale-contents* flake8..............................|ale-python-flake8| isort...............................|ale-python-isort| mypy................................|ale-python-mypy| + prospector..........................|ale-python-prospector| pycodestyle.........................|ale-python-pycodestyle| pylint..............................|ale-python-pylint| pyls................................|ale-python-pyls| @@ -326,7 +327,7 @@ Notes: * proto: `protoc-gen-lint` * Pug: `pug-lint` * Puppet: `puppet`, `puppet-lint` -* Python: `autopep8`, `flake8`, `isort`, `mypy`, `pycodestyle`, `pyls`, `pylint`!!, `yapf` +* Python: `autopep8`, `flake8`, `isort`, `mypy`, `prospector`, `pycodestyle`, `pyls`, `pylint`!!, `yapf` * R: `lintr` * ReasonML: `merlin`, `ols`, `refmt` * reStructuredText: `proselint`, `rstcheck`, `write-good`, `redpen` |