about summary refs log tree commit diff
diff options
context:
space:
mode:
authorFlorian Diebold <flodiebold@gmail.com>2022-05-13 18:12:54 +0200
committerFlorian Diebold <flodiebold@gmail.com>2022-05-13 18:15:33 +0200
commit85fe9391d3cfc1cf05a46e2a8bafcd3e8e154f3d (patch)
tree060349749dfb02f495505238c2a71632348e8774
parent4f6b2a20fd0417c6c1c64163d9ce7a5c915afde1 (diff)
downloadrust-85fe9391d3cfc1cf05a46e2a8bafcd3e8e154f3d.tar.gz
rust-85fe9391d3cfc1cf05a46e2a8bafcd3e8e154f3d.zip
Improve extension description and README
-rw-r--r--editors/code/README.md21
-rw-r--r--editors/code/package.json4
2 files changed, 12 insertions, 13 deletions
diff --git a/editors/code/README.md b/editors/code/README.md
index 9113722632f..36ab9818822 100644
--- a/editors/code/README.md
+++ b/editors/code/README.md
@@ -1,6 +1,7 @@
 # rust-analyzer
 
 This extension provides support for the [Rust programming language](https://www.rust-lang.org/).
+It is recommended over and replaces `rust-lang.rust`.
 
 ## Features
 
@@ -10,9 +11,9 @@ This extension provides support for the [Rust programming language](https://www.
 - [types and documentation on hover]
 - [inlay hints] for types and parameter names
 - [semantic syntax highlighting]
-- a lot of [assists(code actions)]
+- a lot of [assists (code actions)]
 - apply suggestions from errors
-- ... and many more, checkout the [manual] to see them all
+- ... and many more, check out the [manual] to see them all
 
 [code completion]: https://rust-analyzer.github.io/manual.html#magic-completions
 [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.
 [types and documentation on hover]: https://rust-analyzer.github.io/manual.html#hover
 [inlay hints]: https://rust-analyzer.github.io/manual.html#inlay-hints
 [semantic syntax highlighting]: https://rust-analyzer.github.io/manual.html#semantic-syntax-highlighting
-[assists(code actions)]: https://rust-analyzer.github.io/manual.html#assists-code-actions
+[assists (code actions)]: https://rust-analyzer.github.io/manual.html#assists-code-actions
 [manual]: https://rust-analyzer.github.io/manual.html
 
 ## Quick start
 
-1. Install [rustup]
-2. Install the [rust-analyzer extension]
+1. Install [rustup].
+2. Install the [rust-analyzer extension].
 
 [rustup]: https://rustup.rs
 [rust-analyzer extension]: https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer
 
 ## Configuration
 
-This extension provides configurations through VSCode's configuration settings. All the configurations are under `rust-analyzer.*`.
+This extension provides configurations through VSCode's configuration settings. All configurations are under `rust-analyzer.*`.
 
-See <https://rust-analyzer.github.io/manual.html#vs-code-2> for more information on VSCode specific configurations.
+See [the manual](https://rust-analyzer.github.io/manual.html#vs-code-2) for more information on VSCode specific configurations.
 
 ## Communication
 
-For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum:
-
-<https://users.rust-lang.org/c/ide/14>
+For usage and troubleshooting requests, please use the ["IDEs and Editors" category of the Rust forum](https://users.rust-lang.org/c/ide/14).
 
 ## Documentation
 
-See <https://rust-analyzer.github.io/> for more information.
+See [rust-analyzer.github.io](https://rust-analyzer.github.io/) for more information.
diff --git a/editors/code/package.json b/editors/code/package.json
index d21d1139d30..3eba588f83b 100644
--- a/editors/code/package.json
+++ b/editors/code/package.json
@@ -1,7 +1,7 @@
 {
     "name": "rust-analyzer",
     "displayName": "rust-analyzer",
-    "description": "A language server for the rust programming language",
+    "description": "The future of Rust support in VSCode.",
     "preview": true,
     "private": true,
     "icon": "icon.png",
@@ -9,7 +9,7 @@
     "releaseTag": null,
     "publisher": "rust-lang",
     "repository": {
-        "url": "https://github.com/rust-analyzer/rust-analyzer.git",
+        "url": "https://github.com/rust-lang/rust-analyzer.git",
         "type": "git"
     },
     "homepage": "https://rust-analyzer.github.io/",