Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation update #412

Merged
merged 6 commits into from
Nov 20, 2020
Merged

Conversation

karlaspuldaro
Copy link
Contributor

Update requirements in documentation as described in #411

@bollwyvl
Copy link
Collaborator

bollwyvl commented Nov 16, 2020 via email

@lresende
Copy link

@karlaspuldaro there are similar references to prerequisites on the readme that should be updated as well. Below is one example, but there are others.

You will need to have all of the following installed:

JupyterLab >=2.2.0,<3.0.0a0
Python 3.5+
nodejs 10+

@karlaspuldaro
Copy link
Contributor Author

@bollwyvl I ran python scripts/integrity.py tests and they're all passing

@bollwyvl
Copy link
Collaborator

bollwyvl commented Nov 17, 2020

I ran python scripts/integrity.py tests and they're all passing

Right: they would, because the things you fixed ❤️ are not under test. I'm proposing we add these checks to integrity, based on the Source Of Truth for each of the items (most of which are already available in that script). Doesn't have to be on this issue, but will save frustrations in the future, as it's going to be turbulent coming up (i think lab3 needs node12, etc).

But this can be a separate issue, PR.

CONTRIBUTING.md Outdated
- `jupyterlab` 2

It is recommended to use a virtual environment (e.g. `virtualenv` or `conda env`)
for development.

```bash
conda env update -n jupyterlab-lsp # create a conda env
conda create -n jupyterlab-lsp # create a conda env
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

at some point, in an effort to decrease the number of files in the root folder, we moved things into binder, so now the --file arg is required... conda env update has the advantage of being able to, well, update an environment, instead of just creating it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh that makes sense now, when running the command I didn't realize it was expecting a file, or which one. Thx for clarifying :)

setup.cfg Outdated
@@ -1,6 +1,6 @@
[metadata]
name = jupyter-lsp
description = Multi-Language Server WebSocket proxy for Jupyter notebook or lab server for Python 3.5+.
description = Multi-Language Server WebSocket proxy for Jupyter notebook or lab server for Python 3.6+.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also dropped this in favor of python_requires below. Of course, it's not strictly accurate, as we're still doing some unneeded song-and-dance for python 3.5, but since we don't test there anymore...

@krassowski
Copy link
Member

Wonderful! Thank you both.

@krassowski krassowski merged commit a952949 into jupyter-lsp:master Nov 20, 2020
@bollwyvl
Copy link
Collaborator

bollwyvl commented Nov 21, 2020 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants