aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/user/assists.md4
-rw-r--r--docs/user/features.md2
-rw-r--r--docs/user/readme.adoc10
3 files changed, 14 insertions, 2 deletions
diff --git a/docs/user/assists.md b/docs/user/assists.md
index e2850b4dd..f3ce6b0e0 100644
--- a/docs/user/assists.md
+++ b/docs/user/assists.md
@@ -267,8 +267,8 @@ enum Action { Move { distance: u32 }, Stop }
267 267
268fn handle(action: Action) { 268fn handle(action: Action) {
269 match action { 269 match action {
270 Action::Move { distance } => (), 270 Action::Move { distance } => {}
271 Action::Stop => (), 271 Action::Stop => {}
272 } 272 }
273} 273}
274``` 274```
diff --git a/docs/user/features.md b/docs/user/features.md
index 45360c633..56d2969fd 100644
--- a/docs/user/features.md
+++ b/docs/user/features.md
@@ -185,6 +185,7 @@ These contain extended information on the hovered language item.
185Two types of inlay hints are displayed currently: 185Two types of inlay hints are displayed currently:
186 186
187* type hints, displaying the minimal information on the type of the expression (if the information is available) 187* type hints, displaying the minimal information on the type of the expression (if the information is available)
188* method chaining hints, type information for multi-line method chains
188* parameter name hints, displaying the names of the parameters in the corresponding methods 189* parameter name hints, displaying the names of the parameters in the corresponding methods
189 190
190#### VS Code 191#### VS Code
@@ -192,6 +193,7 @@ Two types of inlay hints are displayed currently:
192In VS Code, the following settings can be used to configure the inlay hints: 193In VS Code, the following settings can be used to configure the inlay hints:
193 194
194* `rust-analyzer.inlayHints.typeHints` - enable hints for inferred types. 195* `rust-analyzer.inlayHints.typeHints` - enable hints for inferred types.
196* `rust-analyzer.inlayHints.chainingHints` - enable hints for inferred types on method chains.
195* `rust-analyzer.inlayHints.parameterHints` - enable hints for function parameters. 197* `rust-analyzer.inlayHints.parameterHints` - enable hints for function parameters.
196* `rust-analyzer.inlayHints.maxLength` — shortens the hints if their length exceeds the value specified. If no value is specified (`null`), no shortening is applied. 198* `rust-analyzer.inlayHints.maxLength` — shortens the hints if their length exceeds the value specified. If no value is specified (`null`), no shortening is applied.
197 199
diff --git a/docs/user/readme.adoc b/docs/user/readme.adoc
index 0dfc12b52..e00d14dfb 100644
--- a/docs/user/readme.adoc
+++ b/docs/user/readme.adoc
@@ -98,6 +98,16 @@ You'll need Cargo, nodejs and npm for this.
98 98
99Note that installing via `xtask install` does not work for VS Code Remote, instead you'll need to install the `.vsix` manually. 99Note that installing via `xtask install` does not work for VS Code Remote, instead you'll need to install the `.vsix` manually.
100 100
101==== Troubleshooting
102
103Here are some useful self-diagnostic commands:
104
105* **Rust Analyzer: Show RA Version** shows the version of `rust-analyzer` binary
106* **Rust Analyzer: Status** prints some statistics about the server, like the few latest LSP requests
107* To enable server-side logging, run with `env RUST_LOG=info` and see `Output > Rust Analyzer Language Server` in VS Code's panel.
108* To log all LSP requests, add `"rust-analyzer.trace.server": "verbose"` to the settings and look for `Server Trace` in the panel.
109* To enable client-side logging, add `"rust-analyzer.trace.extension": true` to the settings and open the `Console` tab of VS Code developer tools.
110
101=== Language Server Binary 111=== Language Server Binary
102 112
103Other editors generally require `rust-analyzer` binary to be in `$PATH`. 113Other editors generally require `rust-analyzer` binary to be in `$PATH`.