summaryrefslogtreecommitdiff
path: root/doc/ale-python.txt
diff options
context:
space:
mode:
authorNathan Henrie <n8henrie@users.noreply.github.com>2021-03-17 16:55:50 -0700
committerGitHub <noreply@github.com>2021-03-18 08:55:50 +0900
commited7f4dee532718bd299c42738a3631824b37b5d0 (patch)
tree64504b895cfb191ea881bb261057b9eac5ba53f7 /doc/ale-python.txt
parentdc40ece3c389804df6d9423e0d52c8da2355ea17 (diff)
downloadale-ed7f4dee532718bd299c42738a3631824b37b5d0.zip
issue 3033 (#3620)
* Add ale_python_pyls_options * Add extra explanatory detail * Fix alignment * Fix test
Diffstat (limited to 'doc/ale-python.txt')
-rw-r--r--doc/ale-python.txt19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/ale-python.txt b/doc/ale-python.txt
index 1f263e84..d38d3055 100644
--- a/doc/ale-python.txt
+++ b/doc/ale-python.txt
@@ -688,6 +688,25 @@ 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*
+ 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.
+
+ 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
+ would be:
+ let g:ale_python_pyls_executable = 'python3'
+ let g:ale_python_pyls_options = '-m pyls'
+
+ An example stragety for installing `pyls`:
+ `python3 -m pip install --user pyls`
+
===============================================================================
pyre *ale-python-pyre*