Skip to content
This repository was archived by the owner on May 28, 2025. It is now read-only.

Commit ac4ce42

Browse files
committed
Auto merge of rust-lang#12242 - flodiebold:extension-description, r=flodiebold
Improve extension description and README
2 parents 5ae9847 + 3dcf9e0 commit ac4ce42

File tree

2 files changed

+12
-14
lines changed

2 files changed

+12
-14
lines changed

editors/code/README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# rust-analyzer
22

33
This extension provides support for the [Rust programming language](https://www.rust-lang.org/).
4+
It is recommended over and replaces `rust-lang.rust`.
45

56
## Features
67

@@ -10,9 +11,9 @@ This extension provides support for the [Rust programming language](https://www.
1011
- [types and documentation on hover]
1112
- [inlay hints] for types and parameter names
1213
- [semantic syntax highlighting]
13-
- a lot of [assists(code actions)]
14+
- a lot of [assists (code actions)]
1415
- apply suggestions from errors
15-
- ... and many more, checkout the [manual] to see them all
16+
- ... and many more, check out the [manual] to see them all
1617

1718
[code completion]: https://rust-analyzer.github.io/manual.html#magic-completions
1819
[imports insertion]: https://rust-analyzer.github.io/manual.html#completion-with-autoimport
@@ -25,29 +26,27 @@ This extension provides support for the [Rust programming language](https://www.
2526
[types and documentation on hover]: https://rust-analyzer.github.io/manual.html#hover
2627
[inlay hints]: https://rust-analyzer.github.io/manual.html#inlay-hints
2728
[semantic syntax highlighting]: https://rust-analyzer.github.io/manual.html#semantic-syntax-highlighting
28-
[assists(code actions)]: https://rust-analyzer.github.io/manual.html#assists-code-actions
29+
[assists (code actions)]: https://rust-analyzer.github.io/manual.html#assists-code-actions
2930
[manual]: https://rust-analyzer.github.io/manual.html
3031

3132
## Quick start
3233

33-
1. Install [rustup]
34-
2. Install the [rust-analyzer extension]
34+
1. Install [rustup].
35+
2. Install the [rust-analyzer extension].
3536

3637
[rustup]: https://rustup.rs
3738
[rust-analyzer extension]: https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer
3839

3940
## Configuration
4041

41-
This extension provides configurations through VSCode's configuration settings. All the configurations are under `rust-analyzer.*`.
42+
This extension provides configurations through VSCode's configuration settings. All configurations are under `rust-analyzer.*`.
4243

43-
See <https://rust-analyzer.github.io/manual.html#vs-code-2> for more information on VSCode specific configurations.
44+
See [the manual](https://rust-analyzer.github.io/manual.html#vs-code-2) for more information on VSCode specific configurations.
4445

4546
## Communication
4647

47-
For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum:
48-
49-
<https://users.rust-lang.org/c/ide/14>
48+
For usage and troubleshooting requests, please use the ["IDEs and Editors" category of the Rust forum](https://users.rust-lang.org/c/ide/14).
5049

5150
## Documentation
5251

53-
See <https://rust-analyzer.github.io/> for more information.
52+
See [rust-analyzer.github.io](https://rust-analyzer.github.io/) for more information.

editors/code/package.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
{
22
"name": "rust-analyzer",
33
"displayName": "rust-analyzer",
4-
"description": "A language server for the rust programming language",
5-
"preview": true,
4+
"description": "Rust language support for Visual Studio Code",
65
"private": true,
76
"icon": "icon.png",
87
"version": "0.4.0-dev",
98
"releaseTag": null,
109
"publisher": "rust-lang",
1110
"repository": {
12-
"url": "https://github.com/rust-analyzer/rust-analyzer.git",
11+
"url": "https://github.com/rust-lang/rust-analyzer.git",
1312
"type": "git"
1413
},
1514
"homepage": "https://rust-analyzer.github.io/",

0 commit comments

Comments
 (0)