diff options
Diffstat (limited to 'docs/dev')
-rw-r--r-- | docs/dev/README.md | 3 | ||||
-rw-r--r-- | docs/dev/lsp-extensions.md | 16 | ||||
-rw-r--r-- | docs/dev/style.md | 11 |
3 files changed, 25 insertions, 5 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 a4d92242b..f0f981802 100644 --- a/docs/dev/lsp-extensions.md +++ b/docs/dev/lsp-extensions.md | |||
@@ -1,5 +1,5 @@ | |||
1 | <!--- | 1 | <!--- |
2 | lsp_ext.rs hash: b19ddc3ab8767af9 | 2 | lsp_ext.rs hash: 28a9d5a24b7ca396 |
3 | 3 | ||
4 | If you need to change the above hash to make the test pass, please check if you | 4 | If you need to change the above hash to make the test pass, please check if you |
5 | need to adjust this doc as well and ping this issue: | 5 | need to adjust this doc as well and ping this issue: |
@@ -46,6 +46,7 @@ If this capability is set, `WorkspaceEdit`s returned from `codeAction` requests | |||
46 | ```typescript | 46 | ```typescript |
47 | interface SnippetTextEdit extends TextEdit { | 47 | interface SnippetTextEdit extends TextEdit { |
48 | insertTextFormat?: InsertTextFormat; | 48 | insertTextFormat?: InsertTextFormat; |
49 | annotationId?: ChangeAnnotationIdentifier; | ||
49 | } | 50 | } |
50 | ``` | 51 | ``` |
51 | 52 | ||
@@ -421,7 +422,7 @@ Reloads project information (that is, re-executes `cargo metadata`). | |||
421 | 422 | ||
422 | ## Server Status | 423 | ## Server Status |
423 | 424 | ||
424 | **Experimental Client Capability:** `{ "serverStatus": boolean }` | 425 | **Experimental Client Capability:** `{ "serverStatusNotification": boolean }` |
425 | 426 | ||
426 | **Method:** `experimental/serverStatus` | 427 | **Method:** `experimental/serverStatus` |
427 | 428 | ||
@@ -432,11 +433,13 @@ interface ServerStatusParams { | |||
432 | /// `ok` means that the server is completely functional. | 433 | /// `ok` means that the server is completely functional. |
433 | /// | 434 | /// |
434 | /// `warning` means that the server is partially functional. | 435 | /// `warning` means that the server is partially functional. |
435 | /// It can server requests, but some results might be wrong due to, | 436 | /// It can answer correctly to most requests, but some results |
436 | /// for example, some missing dependencies. | 437 | /// might be wrong due to, for example, some missing dependencies. |
437 | /// | 438 | /// |
438 | /// `error` means that the server is not functional. For example, | 439 | /// `error` means that the server is not functional. For example, |
439 | /// 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. | ||
440 | health: "ok" | "warning" | "error", | 443 | health: "ok" | "warning" | "error", |
441 | /// Is there any pending background work which might change the status? | 444 | /// Is there any pending background work which might change the status? |
442 | /// For example, are dependencies being downloaded? | 445 | /// For example, are dependencies being downloaded? |
@@ -450,6 +453,9 @@ This notification is sent from server to client. | |||
450 | 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). |
451 | 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. |
452 | 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. | ||
453 | 459 | ||
454 | ## Syntax Tree | 460 | ## Syntax Tree |
455 | 461 | ||
diff --git a/docs/dev/style.md b/docs/dev/style.md index 078c478d4..6ab60b50e 100644 --- a/docs/dev/style.md +++ b/docs/dev/style.md | |||
@@ -83,8 +83,19 @@ This makes it easier to prepare a changelog. | |||
83 | 83 | ||
84 | If the change adds a new user-visible functionality, consider recording a GIF with [peek](https://github.com/phw/peek) and pasting it into the PR description. | 84 | If the change adds a new user-visible functionality, consider recording a GIF with [peek](https://github.com/phw/peek) and pasting it into the PR description. |
85 | 85 | ||
86 | To make writing the release notes easier, you can mark a pull request as a feature, fix, internal change, or minor. | ||
87 | Minor changes are excluded from the release notes, while the other types are distributed in their corresponding sections. | ||
88 | There are two ways to mark this: | ||
89 | |||
90 | * use a `feat: `, `feature: `, `fix: `, `internal: ` or `minor: ` prefix in the PR title | ||
91 | * write `changelog [feature|fix|internal|skip] [description]` in a comment or in the PR description; the description is optional, and will replace the title if included. | ||
92 | |||
93 | These comments don't have to be added by the PR author. | ||
94 | Editing a comment or the PR description or title is also fine, as long as it happens before the release. | ||
95 | |||
86 | **Rationale:** clean history is potentially useful, but rarely used. | 96 | **Rationale:** clean history is potentially useful, but rarely used. |
87 | But many users read changelogs. | 97 | But many users read changelogs. |
98 | Including a description and GIF suitable for the changelog means less work for the maintainers on the release day. | ||
88 | 99 | ||
89 | ## Clippy | 100 | ## Clippy |
90 | 101 | ||