diff options
author | Kirill Bulatov <[email protected]> | 2020-02-22 07:23:03 +0000 |
---|---|---|
committer | Kirill Bulatov <[email protected]> | 2020-02-22 07:23:03 +0000 |
commit | 64051ac5c7af84116e200b8e3adecffdf81f3fb4 (patch) | |
tree | 890d7598d1d49eb00e0656b9b9ebbb5f9b8fae20 /docs | |
parent | baf832d6d903afbc39e3a01c752a1aa5218c020e (diff) |
Add inlay hints documentation
Diffstat (limited to 'docs')
-rw-r--r-- | docs/user/features.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/user/features.md b/docs/user/features.md index f705e5115..1c18d3ae1 100644 --- a/docs/user/features.md +++ b/docs/user/features.md | |||
@@ -156,3 +156,28 @@ default highlighter. | |||
156 | 156 | ||
157 | Experimental feature that, given code highlighting using rust-analyzer is | 157 | Experimental feature that, given code highlighting using rust-analyzer is |
158 | active, will pick unique colors for identifiers. | 158 | active, will pick unique colors for identifiers. |
159 | |||
160 | ### Code hints | ||
161 | |||
162 | Rust Analyzer has two types of hints to show the information about the code: | ||
163 | |||
164 | * hover hints, appearing on hover on any element. | ||
165 | |||
166 | Contains extended information on the language item hovered. | ||
167 | |||
168 | * inlay hints, shown near the element hinted directly in the editor. | ||
169 | |||
170 | Two types of inlay hints are displayed currently: | ||
171 | |||
172 | * type hints, displaying the minimal information on the type of the expression (if the information is available) | ||
173 | * parameter name hints, displaying the names of the parameters in the corresponding methods | ||
174 | |||
175 | #### VS Code | ||
176 | |||
177 | In VS Code, the following settings can be used to configure the inlay hints: | ||
178 | |||
179 | * rust-analyzer.displayInlayHints — toggles inlay hints display on or off | ||
180 | * rust-analyzer.maxInlayHintLength — shortens the hints if their length exceed the value specified. If no value is specified (`null`), no shorteninng is applied. | ||
181 | |||
182 | **Note:** VS Code does not have a native support for inlay hints [yet](https://github.com/microsoft/vscode/issues/16221) and the hints are implemented using decorations. | ||
183 | This approach has limitations: the caret movement near the end of the hint may look [weird](https://github.com/rust-analyzer/rust-analyzer/issues/1623). | ||