From 67501ee6c262aacb102071fda65d259318d60a0c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20M=2E=20Martins?= Date: Thu, 2 Oct 2025 13:33:53 +1000 Subject: [PATCH] fixes small typos in docs and indent issue --- docs/book/src/configuration.md | 2 +- docs/book/src/contributing/guide.md | 2 +- docs/book/src/contributing/lsp-extensions.md | 22 ++++++++++---------- docs/book/src/contributing/syntax.md | 2 +- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/book/src/configuration.md b/docs/book/src/configuration.md index fd94a4221a..3f4cb19714 100644 --- a/docs/book/src/configuration.md +++ b/docs/book/src/configuration.md @@ -13,7 +13,7 @@ Vim](./other_editors.md#coc-rust-analyzer) provide `rust-analyzer` specific conf UIs. Others may require you to know a bit more about the interaction with `rust-analyzer`. -For the later category, it might help to know that the initial +For the latter category, it might help to know that the initial configuration is specified as a value of the `initializationOptions` field of the [`InitializeParams` message, in the LSP protocol](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#initialize). diff --git a/docs/book/src/contributing/guide.md b/docs/book/src/contributing/guide.md index 2a2a39af26..d06840368c 100644 --- a/docs/book/src/contributing/guide.md +++ b/docs/book/src/contributing/guide.md @@ -235,7 +235,7 @@ of type `V`. Queries come in two basic varieties: intelligently) when we can re-use these memoized values and when we have to recompute them. -For further discussion, its important to understand one bit of "fairly +For further discussion, it's important to understand one bit of "fairly intelligently". Suppose we have two functions, `f1` and `f2`, and one input, `z`. We call `f1(X)` which in turn calls `f2(Y)` which inspects `i(Z)`. `i(Z)` returns some value `V1`, `f2` uses that and returns `R1`, `f1` uses that and diff --git a/docs/book/src/contributing/lsp-extensions.md b/docs/book/src/contributing/lsp-extensions.md index 8c06f33a9f..91154b6f1c 100644 --- a/docs/book/src/contributing/lsp-extensions.md +++ b/docs/book/src/contributing/lsp-extensions.md @@ -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. @@ -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; }; diff --git a/docs/book/src/contributing/syntax.md b/docs/book/src/contributing/syntax.md index 3dcd430cea..93eed7228d 100644 --- a/docs/book/src/contributing/syntax.md +++ b/docs/book/src/contributing/syntax.md @@ -192,7 +192,7 @@ Modeling this with immutable trees is possible, but annoying. A function green tree is not super-convenient to use. The biggest problem is accessing parents (there are no parent pointers!). -But there are also "identify" issues. +But there are also "identity" issues. Let's say you want to write a code which builds a list of expressions in a file: `fn collect_expressions(file: GreenNode) -> HashSet`. For the input like