Add steps for indexing troubleshooting #2367
Open
+13
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andyw8
added
documentation
andyw8
force-pushed
the
andyw8/document-indexing-troubleshooting
branch
from
93febef
to
2a4b5e5
Compare
vinistock
reviewed
Jul 25, 2024
There was a problem hiding this comment.
Let's link to this new section from the indexing error dialog
ruby-lsp/lib/ruby_lsp/server.rb
Line 778 in a5e1775
|
|
||
| When Ruby LSP starts, it attempts to index your code as well as your dependencies as described in [Configuring code indexing](README.md#configuring-code-indexing). | ||
|
|
||
| In rare cases, Ruby LSP will encounter an error which prevents parsing from completing, meaning Ruby LSP cannot start. |
There was a problem hiding this comment.
We rescue all indexing errors, so that the language server doesn't crash. The only consequence of an indexing failure is incomplete indexing data.
Suggested change
| In rare cases, Ruby LSP will encounter an error which prevents parsing from completing, meaning Ruby LSP cannot start. | |
| In rare cases, Ruby LSP will encounter an error which prevents indexing from completing, which will result in incomplete information in the editor. |
st0012
reviewed
Jul 25, 2024
Co-authored-by: Vinicius Stock <[email protected]>
Co-authored-by: Stan Lo <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #2296