Skip to content

Commit 91ff47e

Browse files
committed
Update vscode README with a small features list
1 parent 5df3ee8 commit 91ff47e

File tree

3 files changed

+46
-0
lines changed

3 files changed

+46
-0
lines changed

crates/ide/src/references.rs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,15 @@ pub struct Declaration {
3939
pub access: Option<ReferenceAccess>,
4040
}
4141

42+
// Feature: Find All References
43+
//
44+
// Shows all references of the item at the cursor location
45+
//
46+
// |===
47+
// | Editor | Shortcut
48+
//
49+
// | VS Code | kbd:[Shift+Alt+F12]
50+
// |===
4251
pub(crate) fn find_all_refs(
4352
sema: &Semantics<RootDatabase>,
4453
position: FilePosition,

crates/ide/src/references/rename.rs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,15 @@ pub(crate) fn prepare_rename(
5959
Ok(RangeInfo::new(range, ()))
6060
}
6161

62+
// Feature: Rename
63+
//
64+
// Renames the item below the cursor and all of its references
65+
//
66+
// |===
67+
// | Editor | Shortcut
68+
//
69+
// | VS Code | kbd:[F2]
70+
// |===
6271
pub(crate) fn rename(
6372
db: &RootDatabase,
6473
position: FilePosition,

editors/code/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,32 @@
22

33
Provides support for rust-analyzer: novel LSP server for the Rust programming language.
44

5+
6+
Features:
7+
8+
* [code completion], [imports insertion]
9+
* [go to definition], [implementation], [type definition]
10+
* [find all references], [workspace symbol search], [rename]
11+
* [types and documentation on hover]
12+
* [inlay hints]
13+
* [semantic syntax highlighting]
14+
* a lot of [assist(code actions)]
15+
* apply suggestions from errors
16+
* ... and many more, checkout the [manual] to see them all
17+
18+
[code completion]: https://rust-analyzer.github.io/manual.html#magic-completions
19+
[imports insertion]: https://rust-analyzer.github.io/manual.html#auto-import
20+
[go to definition]: https://rust-analyzer.github.io/manual.html#go-to-definition
21+
[implementation]: https://rust-analyzer.github.io/manual.html#go-to-implementation
22+
[type definition]: https://rust-analyzer.github.io/manual.html#go-to-type-definition
23+
[find all references]: https://rust-analyzer.github.io/manual.html#find-all-references
24+
[workspace symbol search]: https://rust-analyzer.github.io/manual.html#workspace-symbol
25+
[rename]: https://rust-analyzer.github.io/manual.html#rename
26+
[types and documentation on hover]: https://rust-analyzer.github.io/manual.html#hover
27+
[inlay hints]: https://rust-analyzer.github.io/manual.html#inlay-hints
28+
[semantic syntax highlighting]: https://rust-analyzer.github.io/manual.html#semantic-syntax-highlighting
29+
[assist(code actions)]: https://rust-analyzer.github.io/manual.html#assists-code-actions
30+
31+
[manual]: https://rust-analyzer.github.io/manual.html
32+
533
See https://rust-analyzer.github.io/ for more information.

0 commit comments

Comments
 (0)