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

Document all the differences between similarly named packages #26

Open
maresb opened this issue Apr 26, 2021 · 3 comments
Open

Document all the differences between similarly named packages #26

maresb opened this issue Apr 26, 2021 · 3 comments

Comments

@maresb
Copy link

maresb commented Apr 26, 2021

I feel guilty opening all these issues without PRs, but wanted to offer a fresh outside perspective. I hope you don't mind too much...

jupyter-lsp and jupyterlab-lsp look very similar, as do jupyter-lsp-python and jupyter-lsp-python-lsp-server. From the point of view of someone looking for a quick start, it'd be really convenient to have some reference table like:

  • package name
  • very short description
  • when to install this or not
@bollwyvl
Copy link
Contributor

This is kind of a "sausage-making" repo, and is almost entirely automated from changes to recipe/meta.yaml, and we don't control much of it (in return for it taking care of it building and shipping packages).

  • package name

The README has a link to the different packages.

  • very short description

Yeah, that's pretty much delegated to anaconda.org, where each package has a description with its short description. We can add a longer summary, but it's a crapshoot whether anaconda.org will update it.

  • when to install this or not

I don't really know what that means.

@krassowski
Copy link
Contributor

krassowski commented Apr 26, 2021

very short description/when to install this or not

I think it is best to delegate to the documentation of out project here: https://jupyterlab-lsp.readthedocs.io/en/latest/Installation.html. It certainly can be improved (PRs or concrete ideas welcome!).

package name

I believe that the idea with jupyter-lsp-python was to provide all in one package with pyls; jupyter-lsp-python-lsp-server was an equivalent for new pylsp but the naming is indeed not that helpful. In the ideal world we could use more descriptive names like jupyter-lsp-python-palantir, jupyter-lsp-python-community, and jupyter-lsp-python-jedi. I am not sure how disruptive such change would be. Would it help?

As for jupyter-lsp and jupyterlab-lsp we do want to keep the distinction to allow frontends other than JupyterLab to adopt it in the future. Edit: thinking more of it, maybe we could name the server extension differently like jupyer-lsp-server or jupyer-lsp-handler but again, changing it at this point may not be ideal. The distinction is already explained in https://jupyterlab-lsp.readthedocs.io/en/latest/Installation.html

@bollwyvl
Copy link
Contributor

bollwyvl commented Apr 26, 2021 via email

@krassowski krassowski mentioned this issue May 31, 2021
3 tasks
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

No branches or pull requests

3 participants