Unnamed repository; edit this file 'description' to name the repository.
Diffstat (limited to 'docs/book/src/contributing/lsp-extensions.md')
-rw-r--r--docs/book/src/contributing/lsp-extensions.md48
1 files changed, 24 insertions, 24 deletions
diff --git a/docs/book/src/contributing/lsp-extensions.md b/docs/book/src/contributing/lsp-extensions.md
index 8c06f33a9f..0e91e12612 100644
--- a/docs/book/src/contributing/lsp-extensions.md
+++ b/docs/book/src/contributing/lsp-extensions.md
@@ -23,7 +23,7 @@ If you want to be notified about the changes to this document, subscribe to [#46
## Configuration in `initializationOptions`
-**Upstream Issue:** https://github.com/microsoft/language-server-protocol/issues/567
+**Upstream Issue:** <https://github.com/microsoft/language-server-protocol/issues/567>
The `initializationOptions` field of the `InitializeParams` of the initialization request should contain the `"rust-analyzer"` section of the configuration.
@@ -39,7 +39,7 @@ If a language client does not know about `rust-analyzer`'s configuration options
## Snippet `TextEdit`
-**Upstream Issue:** https://github.com/microsoft/language-server-protocol/issues/724
+**Upstream Issue:** <https://github.com/microsoft/language-server-protocol/issues/724>
**Experimental Client Capability:** `{ "snippetTextEdit": boolean }`
@@ -74,7 +74,7 @@ Any additional `TextDocumentEdit`s will only have edits which are `InsertTextFor
## `CodeAction` Groups
-**Upstream Issue:** https://github.com/microsoft/language-server-protocol/issues/994
+**Upstream Issue:** <https://github.com/microsoft/language-server-protocol/issues/994>
**Experimental Client Capability:** `{ "codeActionGroup": boolean }`
@@ -121,7 +121,7 @@ Invoking code action at this position will yield two code actions for importing
## Parent Module
-**Upstream Issue:** https://github.com/microsoft/language-server-protocol/issues/1002
+**Upstream Issue:** <https://github.com/microsoft/language-server-protocol/issues/1002>
**Experimental Server Capability:** `{ "parentModule": boolean }`
@@ -155,7 +155,7 @@ mod foo;
## Join Lines
-**Upstream Issue:** https://github.com/microsoft/language-server-protocol/issues/992
+**Upstream Issue:** <https://github.com/microsoft/language-server-protocol/issues/992>
**Experimental Server Capability:** `{ "joinLines": boolean }`
@@ -202,7 +202,7 @@ fn main() {
## On Enter
-**Upstream Issue:** https://github.com/microsoft/language-server-protocol/issues/1001
+**Upstream Issue:** <https://github.com/microsoft/language-server-protocol/issues/1001>
**Experimental Server Capability:** `{ "onEnter": boolean }`
@@ -297,7 +297,7 @@ SSR with query `foo($a, $b) ==>> ($a).foo($b)` will transform, eg `foo(y + 5, z)
## Matching Brace
-**Upstream Issue:** https://github.com/microsoft/language-server-protocol/issues/999
+**Upstream Issue:** <https://github.com/microsoft/language-server-protocol/issues/999>
**Experimental Server Capability:** `{ "matchingBrace": boolean }`
@@ -342,7 +342,7 @@ Moreover, it would be cool if editors didn't need to implement even basic langua
## Runnables
-**Upstream Issue:** https://github.com/microsoft/language-server-protocol/issues/944
+**Upstream Issue:** <https://github.com/microsoft/language-server-protocol/issues/944>
**Experimental Server Capability:** `{ "runnables": { "kinds": string[] } }`
@@ -455,7 +455,7 @@ interface TestItem {
// A human readable name for this test
label: string;
// The kind of this test item. Based on the kind,
- // an icon is chosen by the editor.
+ // an icon is chosen by the editor.
kind: "package" | "module" | "test";
// True if this test may have children not available eagerly
canResolveChildren: boolean;
@@ -467,7 +467,7 @@ interface TestItem {
// like debugging, this field is useful.
// Note that this field includes some information about label and location as well, but
// those exist just for keeping things in sync with other methods of running runnables
- // (for example using one consistent name in the vscode's launch.json) so for any propose
+ // (for example using one consistent name in the vscode's launch.json) so for any purpose
// other than running tests this field should not be used.
runnable?: Runnable | undefined;
};
@@ -475,11 +475,11 @@ interface TestItem {
interface DiscoverTestResults {
// The discovered tests.
tests: TestItem[];
- // For each test which its id is in this list, the response
+ // For each test whose id is in this list, the response
// contains all tests that are children of this test, and
// client should remove old tests not included in the response.
scope: string[] | undefined;
- // For each file which its uri is in this list, the response
+ // For each file whose uri is in this list, the response
// contains all tests that are located in this file, and
// client should remove old tests not included in the response.
scopeFile: lc.TextDocumentIdentifier[] | undefined;
@@ -491,7 +491,7 @@ interface DiscoverTestResults {
**Notification:** `DiscoverTestResults`
This notification is sent from the server to the client when the
-server detect changes in the existing tests. The `DiscoverTestResults` is
+server detects changes in the existing tests. The `DiscoverTestResults` is
the same as the one in `experimental/discoverTest` response.
**Method:** `experimental/runTest`
@@ -527,7 +527,7 @@ after this.
This notification is sent from the client to the server when the user is no longer
interested in the test results. The server should clean up its resources and send
-a `experimental/endRunTest` when is done.
+a `experimental/endRunTest` when it is done.
**Method:** `experimental/changeTestState`
@@ -648,8 +648,8 @@ interface ServerStatusParams {
```
This notification is sent from server to client.
-The client can use it to display *persistent* status to the user (in modline).
-It is similar to the `showMessage`, but is intended for stares rather than point-in-time events.
+The client can use it to display *persistent* status to the user (in the mode line).
+It is similar to the `showMessage`, but is intended for status rather than point-in-time events.
Note that this functionality is intended primarily to inform the end user about the state of the server.
In particular, it's valid for the client to completely ignore this extension.
@@ -854,7 +854,7 @@ Such actions on the client side are appended to a hover bottom as command links:
## Open Cargo.toml
-**Upstream Issue:** https://github.com/rust-lang/rust-analyzer/issues/6462
+**Upstream Issue:** <https://github.com/rust-lang/rust-analyzer/issues/6462>
**Experimental Server Capability:** `{ "openCargoToml": boolean }`
@@ -897,7 +897,7 @@ interface TestInfo {
## Hover Range
-**Upstream Issue:** https://github.com/microsoft/language-server-protocol/issues/377
+**Upstream Issue:** <https://github.com/microsoft/language-server-protocol/issues/377>
**Experimental Server Capability:** { "hoverRange": boolean }
@@ -924,7 +924,7 @@ Triggering a hover inside the selection above will show a result of `i32`.
## Move Item
-**Upstream Issue:** https://github.com/rust-lang/rust-analyzer/issues/6823
+**Upstream Issue:** <https://github.com/rust-lang/rust-analyzer/issues/6823>
This request is sent from client to server to move item under cursor or selection in some direction.
@@ -949,7 +949,7 @@ export const enum Direction {
## Workspace Symbols Filtering
-**Upstream Issue:** https://github.com/microsoft/language-server-protocol/issues/941
+**Upstream Issue:** <https://github.com/microsoft/language-server-protocol/issues/941>
**Experimental Server Capability:** `{ "workspaceSymbolScopeKindFiltering": boolean }`
@@ -983,7 +983,7 @@ const enum WorkspaceSymbolSearchKind {
## Client Commands
-**Upstream Issue:** https://github.com/microsoft/language-server-protocol/issues/642
+**Upstream Issue:** <https://github.com/microsoft/language-server-protocol/issues/642>
**Experimental Client Capability:** `{ "commands?": ClientCommandOptions }`
@@ -1070,13 +1070,13 @@ export interface RecursiveMemoryLayoutNode = {
size: number;
/// Alignment of the type in bytes
alignment: number;
- /// Offset of the type relative to its parent (or 0 if its the root)
+ /// Offset of the type relative to its parent (or 0 if it's the root)
offset: number;
- /// Index of the node's parent (or -1 if its the root)
+ /// Index of the node's parent (or -1 if it's the root)
parent_idx: number;
/// Index of the node's children (or -1 if it does not have children)
children_start: number;
- /// Number of child nodes (unspecified it does not have children)
+ /// Number of child nodes (unspecified if it does not have children)
children_len: number;
};