Skip to content

Commit

Permalink
Changelog #232
Browse files Browse the repository at this point in the history
  • Loading branch information
lnicola committed May 6, 2024
1 parent 757cadb commit 87f039b
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 12 deletions.
2 changes: 1 addition & 1 deletion generated_config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ by changing `#rust-analyzer.check.invocationStrategy#` and
If `$saved_file` is part of the command, rust-analyzer will pass
the absolute path of the saved file to the provided command. This is
intended to be used with non-Cargo build systems.
Note that `$saved_file` is experimental and may be removed in the futureg.
Note that `$saved_file` is experimental and may be removed in the future.

An example command would be:

Expand Down
17 changes: 8 additions & 9 deletions generated_features.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ image::https://user-images.githubusercontent.com/48062697/113020654-b42fc800-917


=== Find All References
**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide/src/references.rs#L42[references.rs]
**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide/src/references.rs#L44[references.rs]

Shows all references of the item at the cursor location

Expand Down Expand Up @@ -334,7 +334,7 @@ Note: `?`, `|` and `->` do not currently trigger this behavior in the VSCode edi


=== Hover
**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide/src/hover.rs#L100[hover.rs]
**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide/src/hover.rs#L98[hover.rs]

Shows additional information, like the type of an expression or the documentation for a definition when "focusing" code.
Focusing is usually hovering with a mouse, but can also be triggered with a shortcut.
Expand All @@ -343,7 +343,7 @@ image::https://user-images.githubusercontent.com/48062697/113020658-b5f98b80-917


=== Inlay Hints
**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide/src/inlay_hints.rs#L442[inlay_hints.rs]
**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide/src/inlay_hints.rs#L433[inlay_hints.rs]

rust-analyzer shows additional information inline with the source code.
Editors usually render this using read-only virtual text snippets interspersed with code.
Expand Down Expand Up @@ -414,7 +414,6 @@ There are postfix completions, which can be triggered by typing something like
- `expr.ref` -> `&expr`
- `expr.refm` -> `&mut expr`
- `expr.let` -> `let $0 = expr;`
- `expr.lete` -> `let $1 = expr else { $0 };`
- `expr.letm` -> `let mut $0 = expr;`
- `expr.not` -> `!expr`
- `expr.dbg` -> `dbg!(expr)`
Expand Down Expand Up @@ -464,7 +463,7 @@ image::https://user-images.githubusercontent.com/48062697/113065573-04298180-91b


=== Memory Usage
**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-db/src/apply_change.rs#L44[apply_change.rs]
**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide-db/src/apply_change.rs#L43[apply_change.rs]

Clears rust-analyzer's internal database and prints memory usage statistics.

Expand Down Expand Up @@ -557,7 +556,7 @@ image::https://user-images.githubusercontent.com/48062697/113171066-105c2000-923


=== Open Docs
**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide/src/doc_links.rs#L120[doc_links.rs]
**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide/src/doc_links.rs#L122[doc_links.rs]

Retrieve a links to documentation for the given symbol.

Expand Down Expand Up @@ -586,7 +585,7 @@ image::https://user-images.githubusercontent.com/48062697/113065580-04c21800-91b


=== Related Tests
**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide/src/runnables.rs#L199[runnables.rs]
**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide/src/runnables.rs#L195[runnables.rs]

Provides a sneak peek of all tests where the current item is used.

Expand All @@ -601,7 +600,7 @@ the selected item. The context menu opens. Select **Peek Related Tests**.


=== Rename
**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide/src/rename.rs#L73[rename.rs]
**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide/src/rename.rs#L72[rename.rs]

Renames the item below the cursor and all of its references

Expand All @@ -615,7 +614,7 @@ image::https://user-images.githubusercontent.com/48062697/113065582-055aae80-91b


=== Run
**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide/src/runnables.rs#L113[runnables.rs]
**Source:** https://github.com/rust-lang/rust-analyzer/blob/master/crates/ide/src/runnables.rs#L111[runnables.rs]

Shows a popup suggesting to run a test/benchmark/binary **at the current cursor
location**. Super useful for repeatedly running just a single test. Do bind this
Expand Down
2 changes: 0 additions & 2 deletions manual.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -787,8 +787,6 @@ There are three ways to feed `rust-project.json` to rust-analyzer:

Relative paths are interpreted relative to `rust-project.json` file location or (for inline JSON) relative to `rootUri`.

See https://github.com/rust-analyzer/rust-project.json-example for a small example.

You can set the `RA_LOG` environment variable to `rust_analyzer=info` to inspect how rust-analyzer handles config and project loading.

Note that calls to `cargo check` are disabled when using `rust-project.json` by default, so compilation errors and warnings will no longer be sent to your LSP client.
Expand Down

0 comments on commit 87f039b

Please sign in to comment.