Rewrite / reorganize the troubleshooting documentation #1802
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
Member
rchl
commented
Jul 20, 2021
rchl
commented
- common problems moved to the beginning
- common problems rewritten to be more concise, remove repetition
- in "Completions not shown after certain keywords" removed note about python completion inhibiting issue as that is fixed
- other small changes that are hard to summarize
|
I'll move back stuff to the previous places to hopefully make diff easier to read. |
rchl
commented
Jul 20, 2021
| @@ -15,13 15,11 @@ If the server is crashing on startup, try running `LSP: Troubleshoot server` fro | |||
|
|
|||
| ## Updating the PATH used by LSP servers | |||
|
|
|||
| You can confirm that your issue is due to `PATH` being different by starting Sublime Text from the command line so that it inherits your shell's environment. | |||
| Sublime Text might see a different `PATH` from what your shell environment uses and might not be able to find the server binary due to that. You can see what ST thinks your `PATH` is by opening the ST console by clicking on *View > Show Console*, and running `import os; os.environ["PATH"]` in that console. | |||
There was a problem hiding this comment.
The old text started with "You can confirm that your issue is due..." even though there is no any issue in this context.
Comment on lines
-64
to
-65
| * Make sure you have a folder added in your Sublime workspace. | ||
| * Make sure the document you are opening lives under that folder. |
There was a problem hiding this comment.
Removed as this is no longer the case, we pretty much always start the server. In some cases like LSP-typescript we prevent the start but that gives some feedback in the status bar.
|
|
||
| * Scope (eg. `source.php`): Verify this is correct by running "Show Scope Name" from the developer menu. | ||
| * Syntax (eg. `Packages\PHP\PHP.sublime-syntax`): Verify by running `view.settings().get("syntax")` in the console. |
There was a problem hiding this comment.
The syntax obviously no longer matters so removed.
| export PATH="/usr/local/bin:$PATH" | ||
| ``` | ||
|
|
||
| If, for example, you want to expose a `Node` binary to ST and you have it installed through a version manager like `nvm`, you need to insert its [initialization script](https://github.com/nvm-sh/nvm#install--update-script) in the location specified in [this table](troubleshooting.md#updating-the-path-used-by-lsp-servers) |
There was a problem hiding this comment.
This part about "nvm" moved to the "Updating the PATH used by LSP servers" section
predragnikolic
approved these changes
Jul 23, 2021
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.