summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGerardo Gómez Rodríguez <gerardo.gomez@tutanota.com>2021-07-09 16:40:31 +0300
committerGitHub <noreply@github.com>2021-07-09 22:40:31 +0900
commit8b73d98baf0a185886a55a62b8b32f6543f14af4 (patch)
tree6b35e4b1327688edd442dff867168d49277e6341 /doc
parente230f07465be5b05446da30a098b4a666463503f (diff)
downloadale-8b73d98baf0a185886a55a62b8b32f6543f14af4.zip
chore: replace python-language-server to supported pylsp (#3810)
As mentioned in #3722 palantir's python-language-server is no longer maintained. The alternative is to use the community-driven https://github.com/python-lsp/python-lsp-server.
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-python.txt54
-rw-r--r--doc/ale-supported-languages-and-tools.txt2
-rw-r--r--doc/ale.txt2
3 files changed, 29 insertions, 29 deletions
diff --git a/doc/ale-python.txt b/doc/ale-python.txt
index d38d3055..58b92dc9 100644
--- a/doc/ale-python.txt
+++ b/doc/ale-python.txt
@@ -36,7 +36,7 @@ ALE will look for configuration files with the following filenames. >
.pylintrc
Pipfile
Pipfile.lock
- poetry.lock
+ poetry.lock
pyproject.toml
<
@@ -638,31 +638,31 @@ g:ale_python_pylint_use_msg_id *g:ale_python_pylint_use_msg_id*
===============================================================================
-pyls *ale-python-pyls*
+pylsp *ale-python-pylsp*
-`pyls` will be run from a detected project root, per |ale-python-root|.
+`pylsp` will be run from a detected project root, per |ale-python-root|.
-g:ale_python_pyls_executable *g:ale_python_pyls_executable*
- *b:ale_python_pyls_executable*
+g:ale_python_pylsp_executable *g:ale_python_pylsp_executable*
+ *b:ale_python_pylsp_executable*
Type: |String|
- Default: `'pyls'`
+ Default: `'pylsp'`
See |ale-integrations-local-executables|
- Set this to `'pipenv'` to invoke `'pipenv` `run` `pyls'`.
+ Set this to `'pipenv'` to invoke `'pipenv` `run` `pylsp'`.
-g:ale_python_pyls_use_global *g:ale_python_pyls_use_global*
- *b:ale_python_pyls_use_global*
+g:ale_python_pylsp_use_global *g:ale_python_pylsp_use_global*
+ *b:ale_python_pylsp_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
-g:ale_python_pyls_auto_pipenv *g:ale_python_pyls_auto_pipenv*
- *b:ale_python_pyls_auto_pipenv*
+g:ale_python_pylsp_auto_pipenv *g:ale_python_pylsp_auto_pipenv*
+ *b:ale_python_pylsp_auto_pipenv*
Type: |Number|
Default: `0`
@@ -670,15 +670,15 @@ g:ale_python_pyls_auto_pipenv *g:ale_python_pyls_auto_pipenv*
if true. This is overridden by a manually-set executable.
-g:ale_python_pyls_config *g:ale_python_pyls_config*
- *b:ale_python_pyls_config*
+g:ale_python_pylsp_config *g:ale_python_pylsp_config*
+ *b:ale_python_pylsp_config*
Type: |Dictionary|
Default: `{}`
- Dictionary with configuration settings for pyls. For example, to disable
+ Dictionary with configuration settings for pylsp. For example, to disable
the pycodestyle linter: >
{
- \ 'pyls': {
+ \ 'pylsp': {
\ 'plugins': {
\ 'pycodestyle': {
\ 'enabled': v:false
@@ -688,24 +688,24 @@ g:ale_python_pyls_config *g:ale_python_pyls_config*
\ }
<
-g:ale_python_pyls_options *g:ale_python_pyls_options*
- *b:ale_python_pyls_options*
+g:ale_python_pylsp_options *g:ale_python_pylsp_options*
+ *b:ale_python_pylsp_options*
Type: |String|
Default: `''`
- This variable can be changed to add command-line arguments to the pyls
- invocation. Note that this is not the same thing as ale_python_pyls_config,
- which allows configuration of how pyls functions; this is intended to
- provide flexibility in how the pyls command is invoked.
+ This variable can be changed to add command-line arguments to the pylsp
+ invocation. Note that this is not the same thing as ale_python_pylsp_config,
+ which allows configuration of how pylsp functions; this is intended to
+ provide flexibility in how the pylsp command is invoked.
- For example, if you had installed `pyls` but your `pyls` executable was not
- on your `PATH` for some reason, an alternative way to run the pyls server
+ For example, if you had installed `pylsp` but your `pylsp` executable was not
+ on your `PATH` for some reason, an alternative way to run the pylsp server
would be:
- let g:ale_python_pyls_executable = 'python3'
- let g:ale_python_pyls_options = '-m pyls'
+ let g:ale_python_pylsp_executable = 'python3'
+ let g:ale_python_pylsp_options = '-m pylsp'
- An example stragety for installing `pyls`:
- `python3 -m pip install --user pyls`
+ An example stragety for installing `pylsp`:
+ `python3 -m pip install --user pylsp`
===============================================================================
pyre *ale-python-pyre*
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index 36399178..7f2b632c 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -411,7 +411,7 @@ Notes:
* `pyflakes`
* `pylama`!!
* `pylint`!!
- * `pyls`
+ * `pylsp`
* `pyre`
* `pyright`
* `reorder-python-imports`
diff --git a/doc/ale.txt b/doc/ale.txt
index 5d2ff444..df64f06a 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -2945,7 +2945,7 @@ documented in additional help files.
pyflakes..............................|ale-python-pyflakes|
pylama................................|ale-python-pylama|
pylint................................|ale-python-pylint|
- pyls..................................|ale-python-pyls|
+ pylsp.................................|ale-python-pylsp|
pyre..................................|ale-python-pyre|
pyright...............................|ale-python-pyright|
reorder-python-imports................|ale-python-reorder_python_imports|