diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/dev/README.md | 8 | ||||
-rw-r--r-- | docs/dev/lsp-extensions.md | 6 | ||||
-rw-r--r-- | docs/dev/style.md | 10 | ||||
-rw-r--r-- | docs/user/generated_config.adoc | 6 | ||||
-rw-r--r-- | docs/user/manual.adoc | 2 |
5 files changed, 25 insertions, 7 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md index 9c0eb1358..d0e6d29d8 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md | |||
@@ -235,12 +235,14 @@ We don't do "patch" releases, unless something truly egregious comes up. | |||
235 | 235 | ||
236 | There are three sets of people with extra permissions: | 236 | There are three sets of people with extra permissions: |
237 | 237 | ||
238 | * rust-analyzer GitHub organization **admins** (which include current t-compiler leads). | 238 | * rust-analyzer GitHub organization [**admins**](https://github.com/orgs/rust-analyzer/people?query=role:owner) (which include current t-compiler leads). |
239 | Admins have full access to the org. | 239 | Admins have full access to the org. |
240 | * **review** team in the organization. | 240 | * [**review**](https://github.com/orgs/rust-analyzer/teams/review) team in the organization. |
241 | Reviewers have `r+` access to all of organization's repositories and publish rights on crates.io. | 241 | Reviewers have `r+` access to all of organization's repositories and publish rights on crates.io. |
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 | * **triage** team in the organization. | 245 | * [**triage**](https://github.com/orgs/rust-analyzer/teams/triage) team in the organization. |
246 | This team can label and close issues. | 246 | This team can label and close issues. |
247 | |||
248 | Note that at the time being you need to be a member of the org yourself to view the links. | ||
diff --git a/docs/dev/lsp-extensions.md b/docs/dev/lsp-extensions.md index a46121bb2..a4d92242b 100644 --- a/docs/dev/lsp-extensions.md +++ b/docs/dev/lsp-extensions.md | |||
@@ -1,8 +1,8 @@ | |||
1 | <!--- | 1 | <!--- |
2 | lsp_ext.rs hash: faae991334a151d0 | 2 | lsp_ext.rs hash: b19ddc3ab8767af9 |
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: |
6 | 6 | ||
7 | https://github.com/rust-analyzer/rust-analyzer/issues/4604 | 7 | https://github.com/rust-analyzer/rust-analyzer/issues/4604 |
8 | 8 | ||
@@ -620,7 +620,7 @@ This request is sent from client to server to move item under cursor or selectio | |||
620 | 620 | ||
621 | **Request:** `MoveItemParams` | 621 | **Request:** `MoveItemParams` |
622 | 622 | ||
623 | **Response:** `TextDocumentEdit | null` | 623 | **Response:** `SnippetTextEdit[]` |
624 | 624 | ||
625 | ```typescript | 625 | ```typescript |
626 | export interface MoveItemParams { | 626 | export interface MoveItemParams { |
diff --git a/docs/dev/style.md b/docs/dev/style.md index 468dedff2..078c478d4 100644 --- a/docs/dev/style.md +++ b/docs/dev/style.md | |||
@@ -152,6 +152,16 @@ Do not reuse marks between several tests. | |||
152 | 152 | ||
153 | **Rationale:** marks provide an easy way to find the canonical test for each bit of code. | 153 | **Rationale:** marks provide an easy way to find the canonical test for each bit of code. |
154 | This makes it much easier to understand. | 154 | This makes it much easier to understand. |
155 | More than one mark per test / code branch doesn't add significantly to understanding. | ||
156 | |||
157 | ## `#[should_panic]` | ||
158 | |||
159 | Do not use `#[should_panic]` tests. | ||
160 | Instead, explicitly check for `None`, `Err`, etc. | ||
161 | |||
162 | **Rationale:** `#[should_panic]` is a tool for library authors, to makes sure that API does not fail silently, when misused. | ||
163 | `rust-analyzer` is not a library, we don't need to test for API misuse, and we have to handle any user input without panics. | ||
164 | Panic messages in the logs from the `#[should_panic]` tests are confusing. | ||
155 | 165 | ||
156 | ## Function Preconditions | 166 | ## Function Preconditions |
157 | 167 | ||
diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc index 871c65add..e0ee35b4e 100644 --- a/docs/user/generated_config.adoc +++ b/docs/user/generated_config.adoc | |||
@@ -39,6 +39,12 @@ List of features to activate. | |||
39 | -- | 39 | -- |
40 | Run build scripts (`build.rs`) for more precise code analysis. | 40 | Run build scripts (`build.rs`) for more precise code analysis. |
41 | -- | 41 | -- |
42 | [[rust-analyzer.cargo.useRustcWrapperForBuildScripts]]rust-analyzer.cargo.useRustcWrapperForBuildScripts (default: `true`):: | ||
43 | + | ||
44 | -- | ||
45 | Use `RUSTC_WRAPPER=rust-analyzer` when running build scripts to | ||
46 | avoid compiling unnecessary things. | ||
47 | -- | ||
42 | [[rust-analyzer.cargo.noDefaultFeatures]]rust-analyzer.cargo.noDefaultFeatures (default: `false`):: | 48 | [[rust-analyzer.cargo.noDefaultFeatures]]rust-analyzer.cargo.noDefaultFeatures (default: `false`):: |
43 | + | 49 | + |
44 | -- | 50 | -- |
diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc index e74b287fb..b86e91772 100644 --- a/docs/user/manual.adoc +++ b/docs/user/manual.adoc | |||
@@ -541,7 +541,7 @@ include::./generated_assists.adoc[] | |||
541 | == Diagnostics | 541 | == Diagnostics |
542 | 542 | ||
543 | While most errors and warnings provided by rust-analyzer come from the `cargo check` integration, there's a growing number of diagnostics implemented using rust-analyzer's own analysis. | 543 | While most errors and warnings provided by rust-analyzer come from the `cargo check` integration, there's a growing number of diagnostics implemented using rust-analyzer's own analysis. |
544 | These diagnostics don't respect `#[allow]` or `#[deny]` attributes yet, but can be turned off using the `rust-analyzer.diagnostics.enable`, `rust-analyzer.diagnostics.enableExperimental` or `rust-analyzer.diagnostics.disabled` settings. | 544 | Some of these diagnostics don't respect `\#[allow]` or `\#[deny]` attributes yet, but can be turned off using the `rust-analyzer.diagnostics.enable`, `rust-analyzer.diagnostics.enableExperimental` or `rust-analyzer.diagnostics.disabled` settings. |
545 | 545 | ||
546 | include::./generated_diagnostic.adoc[] | 546 | include::./generated_diagnostic.adoc[] |
547 | 547 | ||