Skip to content

Commit

Permalink
Docs: Clarify logs = sublime console and update meaning of languageId
Browse files Browse the repository at this point in the history
Closes #662
Closes #663
  • Loading branch information
tomv564 committed Jul 22, 2019
1 parent d0b5752 commit ba057b3
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 2 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -393,13 +393,14 @@ or in multi-language form:
* `tcp_port` - if not specified then stdin/out are used else sets the tcpport to connect to (if no command is specified then it is assumed that some process is listing on this port)
* `scopes` - add language flavours, eg. `source.js`, `source.jsx`.
* `syntaxes` - syntaxes that enable LSP features on a document, eg. `Packages/Babel/JavaScript (Babel).tmLanguage`
* `languageId` - used both by the language servers and to select a syntax highlighter for sublime popups.
* `languageId` - identifies the language for a document - see https://microsoft.github.io/language-server-protocol/specification#textdocumentitem
* `languages` - group scope, syntax and languageId together for servers that support more than one language
* `enabled` - enables a language server (default is disabled)
* `settings` - per-project settings (equivalent to VS Code's Workspace Settings)
* `env` - dict of environment variables to be injected into the language server's process (eg. PYTHONPATH)
* `initializationOptions` - options to send to the server at startup (rarely used)


## Per-project overrides

Any global language server settings can be overridden per project by adding an LSP settings block to your `.sublime-project` file.
Expand Down
3 changes: 2 additions & 1 deletion docs/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
## Self-help instructions

In LSP Settings enable the `log_debug` setting and `log_payloads` if needed. Restart Sublime and watch the logs as you reproduce the problem.
In LSP Settings enable the `log_debug` setting and `log_payloads` if needed.
Restart Sublime and open the console (super+~) to see the additional logging.
If you believe the issue is with this package, please include the output from the Sublime console in your issue report!

> **NOTE:** `log_stderr` can also be set to `true` to see the language server's own logging.
Expand Down

0 comments on commit ba057b3

Please sign in to comment.