From 64051ac5c7af84116e200b8e3adecffdf81f3fb4 Mon Sep 17 00:00:00 2001 From: Kirill Bulatov Date: Sat, 22 Feb 2020 10:23:03 +0300 Subject: Add inlay hints documentation --- docs/user/features.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) (limited to 'docs') 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. Experimental feature that, given code highlighting using rust-analyzer is active, will pick unique colors for identifiers. + +### Code hints + +Rust Analyzer has two types of hints to show the information about the code: + +* hover hints, appearing on hover on any element. + +Contains extended information on the language item hovered. + +* inlay hints, shown near the element hinted directly in the editor. + +Two types of inlay hints are displayed currently: + +* type hints, displaying the minimal information on the type of the expression (if the information is available) +* parameter name hints, displaying the names of the parameters in the corresponding methods + +#### VS Code + +In VS Code, the following settings can be used to configure the inlay hints: + +* rust-analyzer.displayInlayHints — toggles inlay hints display on or off +* rust-analyzer.maxInlayHintLength — shortens the hints if their length exceed the value specified. If no value is specified (`null`), no shorteninng is applied. + +**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. +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). -- cgit v1.2.3