LSP: documentation not shown for used packages

Tooling
1

Sublime Text (4) + LSP-julia.
Documentation is available for functions and types from standard packages (or base), but not from other used packages. Case at hand: GitHub - PetrKryslUCSD/VibrationGEPHelpers.jl: Generalized Eigenvalue Problem helper functions.

image
image1088×711 112 KB

But:
image
image1284×436 57.2 KB

(From ArnoldiMethod.jl)
image
image954×566 60.5 KB

(From Arpack.jl)
Structure of package:
image
image731×465 26.8 KB

Is this is a known problem? With a solution (:wink: )?

Edit: Tested with VSCode: all works. LinearMap, partialschur, … I am not sure, but I think VSCode does not use LSP-julia(?). Is the problem there?

2

The core implementation of the Language Server Protocol for Julia is GitHub - julia-vscode/LanguageServer.jl: An implementation of the Microsoft Language Server Protocol for the Julia language.

1 Like
3

For sure. However I do believe there are differences in the clients: VSCode behaves differently from ST (4). Tested on precisely the same package, ST (4) fails to display symbols for certain dependencies, while VSCode handles all well.

4

That’s interesting. As another data point, it seems to work for Emacs as well:

Screenshot_2024-01-30_08-32-06
Screenshot_2024-01-30_08-32-061376×975 141 KB

Screenshot_2024-01-30_08-32-38
Screenshot_2024-01-30_08-32-381376×975 123 KB

This is eglot-jl with an up-to-date LanguageServer:

(eglot-jl-20221128.1655) pkg> st
Status `~/.emacs.d/elpa/eglot-jl-20221128.1655/Project.toml`
  [2b0e0bc5] LanguageServer v4.5.0
  [cf896787] SymbolServer v7.3.0

I’m relatively familiar with the eglot-jl code base, and almost positive that it does not do anything fancy: simply starts the LanguageServer and communicate with it. So I’m not sure what could be missing in SublimeText and its LSP extension.

1 Like
5

I do not know that either, but I do see that the editor does not do the same thing as VSCode. Since I believe they share the same implementation of the server component (LanguageServer.jl), I think that difference would be in the code that handles the communication on the client side.

6

The main questions are what environment ST/VS Code/emacs use for package resolution in this specific case, and whether that environment is instantiated.

1 Like
7

Good point, thanks!

In case that helps fixing things in SublimeText, this is how eglot-jl determines the project path that the LanguageServer will use:

(In this code, src_path refers to the directory of the source file currently being edited)