diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/dev/README.md | 3 | ||||
-rw-r--r-- | docs/dev/lsp-extensions.md | 13 |
2 files changed, 12 insertions, 4 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md index d0e6d29d8..7e4488a41 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md | |||
@@ -242,6 +242,9 @@ There are three sets of people with extra permissions: | |||
242 | They also have direct commit access, but all changes should via bors queue. | 242 | They also have direct commit access, but all changes should via bors queue. |
243 | It's ok to self-approve if you think you know what you are doing! | 243 | It's ok to self-approve if you think you know what you are doing! |
244 | bors should automatically sync the permissions. | 244 | bors should automatically sync the permissions. |
245 | Feel free to request a review or assign any PR to a reviewer with the relevant expertise to bring the work to their attention. | ||
246 | Don't feel pressured to review assigned PRs though. | ||
247 | If you don't feel like reviewing for whatever reason, someone else will pick the review up! | ||
245 | * [**triage**](https://github.com/orgs/rust-analyzer/teams/triage) team in the organization. | 248 | * [**triage**](https://github.com/orgs/rust-analyzer/teams/triage) team in the organization. |
246 | This team can label and close issues. | 249 | This team can label and close issues. |
247 | 250 | ||
diff --git a/docs/dev/lsp-extensions.md b/docs/dev/lsp-extensions.md index a112477de..f0f981802 100644 --- a/docs/dev/lsp-extensions.md +++ b/docs/dev/lsp-extensions.md | |||
@@ -422,7 +422,7 @@ Reloads project information (that is, re-executes `cargo metadata`). | |||
422 | 422 | ||
423 | ## Server Status | 423 | ## Server Status |
424 | 424 | ||
425 | **Experimental Client Capability:** `{ "serverStatus": boolean }` | 425 | **Experimental Client Capability:** `{ "serverStatusNotification": boolean }` |
426 | 426 | ||
427 | **Method:** `experimental/serverStatus` | 427 | **Method:** `experimental/serverStatus` |
428 | 428 | ||
@@ -433,11 +433,13 @@ interface ServerStatusParams { | |||
433 | /// `ok` means that the server is completely functional. | 433 | /// `ok` means that the server is completely functional. |
434 | /// | 434 | /// |
435 | /// `warning` means that the server is partially functional. | 435 | /// `warning` means that the server is partially functional. |
436 | /// It can server requests, but some results might be wrong due to, | 436 | /// It can answer correctly to most requests, but some results |
437 | /// for example, some missing dependencies. | 437 | /// might be wrong due to, for example, some missing dependencies. |
438 | /// | 438 | /// |
439 | /// `error` means that the server is not functional. For example, | 439 | /// `error` means that the server is not functional. For example, |
440 | /// there's a fatal build configuration problem. | 440 | /// there's a fatal build configuration problem. The server might |
441 | /// still give correct answers to simple requests, but most results | ||
442 | /// will be incomplete or wrong. | ||
441 | health: "ok" | "warning" | "error", | 443 | health: "ok" | "warning" | "error", |
442 | /// Is there any pending background work which might change the status? | 444 | /// Is there any pending background work which might change the status? |
443 | /// For example, are dependencies being downloaded? | 445 | /// For example, are dependencies being downloaded? |
@@ -451,6 +453,9 @@ This notification is sent from server to client. | |||
451 | The client can use it to display *persistent* status to the user (in modline). | 453 | The client can use it to display *persistent* status to the user (in modline). |
452 | It is similar to the `showMessage`, but is intended for stares rather than point-in-time events. | 454 | It is similar to the `showMessage`, but is intended for stares rather than point-in-time events. |
453 | 455 | ||
456 | Note that this functionality is intended primarily to inform the end user about the state of the server. | ||
457 | In particular, it's valid for the client to completely ignore this extension. | ||
458 | Clients are discouraged from but are allowed to use the `health` status to decide if it's worth sending a request to the server. | ||
454 | 459 | ||
455 | ## Syntax Tree | 460 | ## Syntax Tree |
456 | 461 | ||