From f792fbf87a86fe4d46ec2c340bb8b409f94a1a87 Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Fri, 22 Sep 2023 18:17:36 +0100 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Andy Waite <13400+andyw8@users.noreply.github.com> --- README.md | 2 +- VERSION_MANAGERS.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4ecdad8b..0ba20be4 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ To make sure that the Ruby LSP can find the version manager scripts, make sure t configuration script (e.g.: ~/.bashrc, ~/.zshrc) and that the SHELL environment variable is set and pointing to the default shell. -> **Note** +> [!NOTE] > > For manager-specific notes and how to set up custom activation for managers that are not listed above, please see [version managers](VERSION_MANAGERS.md). diff --git a/VERSION_MANAGERS.md b/VERSION_MANAGERS.md index 9a7a67ff..5572a535 100644 --- a/VERSION_MANAGERS.md +++ b/VERSION_MANAGERS.md @@ -1,17 +1,17 @@ ## Chruby -If you use `chruby` but don't have `.ruby-version` in a project, you can add `.ruby-version` to its parent folder as a fallback. +If you use `chruby` but don't have a `.ruby-version` file in the project root, you can add `.ruby-version` to its parent folder as a fallback. For example, if `/projects/my_project` doesn't have `.ruby-version`, `chruby` would read `/projects/.ruby-version` instead. ## Custom activation -If you're using a different version manager that's not supported by us or if you're manually inserting the Ruby +If you're using a different version manager that's not supported by this extension or if you're manually inserting the Ruby executable into the PATH, you will probably need to define custom activation so that the extension can find the correct Ruby. For these cases, set `rubyLsp.rubyVersionManager` to `"custom"` and then set `rubyLsp.customRubyCommand` to a shell -command that will activate the right Ruby version or simply add the Ruby bin folder to the PATH. Some examples: +command that will activate the right Ruby version or add the Ruby `bin` folder to the `PATH`. Some examples: ```jsonc {