]> git.lizzy.rs Git - rust.git/commitdiff
Document the protocol extension
authorZac Pullar-Strecker <zacmps@gmail.com>
Tue, 1 Sep 2020 08:36:48 +0000 (20:36 +1200)
committerZac Pullar-Strecker <zacmps@gmail.com>
Thu, 8 Oct 2020 02:04:20 +0000 (15:04 +1300)
docs/dev/lsp-extensions.md

index f1160bb1cc949d4cbdba247a74cc5326475214dc..173c04a142abbfa4f7ee2eab32c17de1de083d3d 100644 (file)
@@ -303,7 +303,7 @@ SSR with query `foo($a, $b) ==>> ($a).foo($b)` will transform, eg `foo(y + 5, z)
 
 **Server Capability:** `{ "matchingBrace": boolean }`
 
-This request is send from client to server to handle "Matching Brace" editor action.
+This request is sent from client to server to handle "Matching Brace" editor action.
 
 **Method:** `experimental/matchingBrace`
 
@@ -386,6 +386,17 @@ rust-analyzer supports only one `kind`, `"cargo"`. The `args` for `"cargo"` look
 }
 ```
 
+## Open External Documentation
+
+This request is send from client to server to get a URL to documentation for the symbol under the cursor, if available.
+
+**Method** `experimental/externalDocs`
+
+**Request:**: `TextDocumentPositionParams`
+
+**Response** `string | null`
+
+
 ## Analyzer Status
 
 **Method:** `rust-analyzer/analyzerStatus`