Skip to content

Commit f17e4b8

Browse files
authored
Add notes on pyls dependencies issues
1 parent 2fab3ec commit f17e4b8

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,8 +153,16 @@ Use of a python `virtualenv` or a conda env is also recommended.
153153
[Microsoft list](https://microsoft.github.io/language-server-protocol/implementors/servers/)
154154
should work after [some additional configuration](./CONTRIBUTING.md#specs).
155155

156-
Note: it may be worth visiting the repository of each server you install as
156+
Note: it is worth visiting the repository of each server you install as
157157
many provide additional configuration options.
158+
159+
Note on pyls (python-language-server) issues: pyls is known to require specific
160+
versions of some dependencies such as [ujson <= 1.35](
161+
https://github.com/krassowski/jupyterlab-lsp/issues/203#issuecomment-599039556
162+
), [jedi == 0.15.2 and parso == 0.5.2](
163+
https://github.com/krassowski/jupyterlab-lsp/issues/200#issuecomment-599039353
164+
). If you experience any issues with LSP functions in Python,
165+
please check if you have the right version using `pip freeze` command.
158166

159167
1. (Optional, Linux/OSX-only) to enable opening files outside of the root
160168
directory (the place where you start JupyterLab), create `.lsp_symlink` and
@@ -196,7 +204,7 @@ We plan to provide a configuration GUI at some time ([#25](https://github.com/kr
196204

197205
#### I want to hide specific diagnostics/inspections/warnings
198206

199-
For example, the Python server that we support by default ([pyls](https://github.com/palantir/python-language-server)) has a [configuration section](https://github.com/palantir/python-language-server#configuration) in ther documentation which refers to the providers of specific features, including `pycodestyle` for inspections/diagnostics.
207+
For example, the Python server that we support by default ([pyls](https://github.com/palantir/python-language-server)) has a [configuration section](https://github.com/palantir/python-language-server#configuration) in their documentation which refers to the providers of specific features, including `pycodestyle` for inspections/diagnostics.
200208

201209
The exact configuration details will vary between operating systems (please see the [configuration section of pycodestyle documentation](https://pycodestyle.readthedocs.io/en/latest/intro.html#configuration)), but as an example, on Linux you would simply need to create a file called `~/.config/pycodestyle`, which may look like that:
202210

0 commit comments

Comments
 (0)