diff options
| author | Ddystopia <alexanderbabak@proton.me> | 2023-04-28 10:27:16 +0200 |
|---|---|---|
| committer | Ddystopia <alexanderbabak@proton.me> | 2023-05-02 17:13:21 +0200 |
| commit | 7e19d99d4f0631b141d4d49a49cd5c504726cf9c (patch) | |
| tree | ecd484c2a116cf9a0adf40a30304ee142e078519 /docs/dev | |
| parent | 4ac39f0c98648b7095332d8b821cf93c935fdc3f (diff) | |
| download | rust-7e19d99d4f0631b141d4d49a49cd5c504726cf9c.tar.gz rust-7e19d99d4f0631b141d4d49a49cd5c504726cf9c.zip | |
Add a `localDocs` capability
Diffstat (limited to 'docs/dev')
| -rw-r--r-- | docs/dev/lsp-extensions.md | 22 |
1 files changed, 17 insertions, 5 deletions
diff --git a/docs/dev/lsp-extensions.md b/docs/dev/lsp-extensions.md index 13407f80b22..bc58aa7220d 100644 --- a/docs/dev/lsp-extensions.md +++ b/docs/dev/lsp-extensions.md @@ -1,5 +1,5 @@ <!--- -lsp_ext.rs hash: 4e825bd8f3921c87 +lsp_ext.rs hash: 2d60bbffe70ae198 If you need to change the above hash to make the test pass, please check if you need to adjust this doc as well and ping this issue: @@ -386,14 +386,26 @@ rust-analyzer supports only one `kind`, `"cargo"`. The `args` for `"cargo"` look ## Open External Documentation -This request is sent from client to server to get a web and local URL(s) to documentation for the symbol under the cursor, if available. +This request is sent from the client to the server to obtain web and local URL(s) for documentation related to the symbol under the cursor, if available. -**Method** `experimental/externalDocs` +**Method:** `experimental/externalDocs` -**Request:**: `TextDocumentPositionParams` +**Request:** `TextDocumentPositionParams` + +**Response:** `string | null` + +## Local Documentation -**Response** `[string | null, string | null]` +**Experimental Client Capability:** `{ "localDocs": boolean }` +If this capability is set, the `Open External Documentation` request returned from the server will have the following structure: + +```typescript +interface ExternalDocsResponse { + web?: string; + local?: string; +} +``` ## Analyzer Status |