docs: Move Steep in Ruby Section & minor cleanups #2377
Conversation
... as no other LSP instruction has this.
Co-authored-by: Предраг Николић <[email protected]>
docs/src/language_servers.md
Outdated
| "clients": { | ||
| "steep": { | ||
| "enabled": true, | ||
| "command": ["bin/steep", "langserver"], |
There was a problem hiding this comment.
Is this supposed to be a relative path? Because it is here but since this is a global server configuration, it's not likely to work.
docs/src/language_servers.md
Outdated
| 1. Add the `steep` gem (see [github:soutaro/steep](https://github.com/soutaro/steep)) into your Gemfile and install it | ||
|
|
||
| ```sh | ||
| bundle install |
There was a problem hiding this comment.
I don't know the ruby ecosystem but why are those instructions say to add to "gemfile" while instructions for other servers say to use gem install? Is it because this approach is local to the project while gem install is for installing globally? If so then shouldn't we recommend to install globally in this case also?
There was a problem hiding this comment.
I've been thinking about this, too. I already had a commit prepared but skipped it as I did not want to change too much in the scope of this PR. Especially that no other Ruby LSP mentions the "add it to your project" way, which it is when adding it to the Gemfile - I also thought it should be changed. I am not sure if dropping this & migrate it to the global way wouldn't be the best solution.
Generally speaking, in order to try steep & test it, locally I did the gem install way to verify it works - and not the described.
Shall I rewrite it to align it with the others?
There was a problem hiding this comment.
I would say that project-specific setup should be combined with a project-specific configuration. Unless there is something specific about this server that makes it more suitable for project-specific use, I'd suggest following other setups for global server.
There was a problem hiding this comment.
Just pushed a commit with a global setup configuration.
As always, please feel free to request changes or do them on your own if I missed something.
Thanks & cheers!