Skip to content

Commit 77d9357

Browse files
authored
Merge pull request #220 from krassowski/pyls-dependencies-readme
Add notes on pyls dependencies issues
2 parents f36a331 + d1ee498 commit 77d9357

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,9 +150,13 @@ Use of a python `virtualenv` or a conda env is also recommended.
150150
[Microsoft list](https://microsoft.github.io/language-server-protocol/implementors/servers/)
151151
should work after [some additional configuration](./CONTRIBUTING.md#specs).
152152

153-
Note: it may be worth visiting the repository of each server you install as
153+
Note: it is worth visiting the repository of each server you install as
154154
many provide additional configuration options.
155155

156+
Note on pyls (python-language-server) issues: pyls is known to require specific
157+
versions of some dependencies such as [ujson <= 1.35](https://github.com/krassowski/jupyterlab-lsp/issues/203#issuecomment-599039556), [jedi == 0.15.2 and parso == 0.5.2](https://github.com/krassowski/jupyterlab-lsp/issues/200#issuecomment-599039353). If you experience any issues with LSP functions in Python,
158+
please check if you have the right version using `pip freeze` command.
159+
156160
1. (Optional, Linux/OSX-only) to enable opening files outside of the root
157161
directory (the place where you start JupyterLab), create `.lsp_symlink` and
158162
symlink your `/home`, or any other location which includes the files that you
@@ -193,7 +197,7 @@ We plan to provide a configuration GUI at some time ([#25](https://github.com/kr
193197

194198
#### I want to hide specific diagnostics/inspections/warnings
195199

196-
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.
200+
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.
197201

198202
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:
199203

0 commit comments

Comments
 (0)