about summary refs log tree commit diff
path: root/docs/dev
diff options
context:
space:
mode:
authorbors[bot] <26634292+bors[bot]@users.noreply.github.com>2020-07-22 14:56:34 +0000
committerGitHub <noreply@github.com>2020-07-22 14:56:34 +0000
commit20b37f264fe89f048d052e2b7c86884d3103cc9e (patch)
tree7d655cbcb1ea37798af7615c8c6d28e16410248a /docs/dev
parent1c7d5f513cc583413a717fa14c2a394c182d69d6 (diff)
parent9c0ead30b97ddb9784b20c06aebd2fbf0187a106 (diff)
downloadrust-20b37f264fe89f048d052e2b7c86884d3103cc9e.tar.gz
rust-20b37f264fe89f048d052e2b7c86884d3103cc9e.zip
Merge #5489
5489: Clarify initializationOptions r=matklad a=kjeremy



Co-authored-by: Jeremy Kolb <kjeremy@gmail.com>
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/lsp-extensions.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/dev/lsp-extensions.md b/docs/dev/lsp-extensions.md
index 6d6bbac7ca1..98d14450b1b 100644
--- a/docs/dev/lsp-extensions.md
+++ b/docs/dev/lsp-extensions.md
@@ -11,11 +11,13 @@ If you want to be notified about the changes to this document, subscribe to [#46
 
 ## `initializationOptions`
 
-As `initializationOptions`, `rust-analyzer` expects `"rust-analyzer"` section of the configuration.
+For `initializationOptions`, `rust-analyzer` expects `"rust-analyzer"` section of the configuration.
 That is, `rust-analyzer` usually sends `"workspace/configuration"` request with `{ "items": ["rust-analyzer"] }` payload.
 `initializationOptions` should contain the same data that would be in the first item of the result.
-It's OK to not send anything, then all the settings would take their default values.
-However, some settings can not be changed after startup at the moment.
+If a language client does not know about `rust-analyzer`'s configuration options it can get sensible defaults by doing any of the following:
+ * Not sending `initializationOptions`
+ * Send `"initializationOptions": null`
+ * Send `"initializationOptions": {}`
 
 ## Snippet `TextEdit`