Skip to content

Commit 6fbe22b

Browse files
committed
Split lines between sentences
1 parent 0ecb224 commit 6fbe22b

File tree

1 file changed

+27
-15
lines changed

1 file changed

+27
-15
lines changed

docs/user/manual.adoc

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ You can install the latest release of the plugin from
4646
https://marketplace.visualstudio.com/items?itemName=matklad.rust-analyzer[the marketplace].
4747

4848
Note that the plugin may cause conflicts with the
49-
https://marketplace.visualstudio.com/items?itemName=rust-lang.rust[official Rust plugin]. It is
50-
recommended to disable the Rust plugin when using the rust-analyzer extension.
49+
https://marketplace.visualstudio.com/items?itemName=rust-lang.rust[official Rust plugin].
50+
It is recommended to disable the Rust plugin when using the rust-analyzer extension.
5151

5252
By default, the plugin will prompt you to download the matching version of the server as well:
5353

@@ -74,18 +74,21 @@ Note that we only support two most recent versions of VS Code.
7474

7575
==== Updates
7676

77-
The extension will be updated automatically as new versions become available. It will ask your permission to download the matching language server version binary if needed.
77+
The extension will be updated automatically as new versions become available.
78+
It will ask your permission to download the matching language server version binary if needed.
7879

7980
===== Nightly
8081

81-
We ship nightly releases for VS Code. To help us out with testing the newest code and follow the bleeding edge of our `master`, please use the following config:
82+
We ship nightly releases for VS Code.
83+
To help us out with testing the newest code and follow the bleeding edge of our `master`, please use the following config:
8284

8385
[source,json]
8486
----
8587
{ "rust-analyzer.updates.channel": "nightly" }
8688
----
8789

88-
You will be prompted to install the `nightly` extension version. Just click `Download now` and from that moment you will get automatic updates every 24 hours.
90+
You will be prompted to install the `nightly` extension version.
91+
Just click `Download now` and from that moment you will get automatic updates every 24 hours.
8992

9093
If you don't want to be asked for `Download now` every day when the new nightly version is released add the following to your `settings.json`:
9194
[source,json]
@@ -160,7 +163,8 @@ $ chmod +x ~/.local/bin/rust-analyzer
160163

161164
Ensure `~/.local/bin` is listed in the `$PATH` variable.
162165

163-
Alternatively, you can install it from source using the command below. You'll need the latest stable version of the Rust toolchain.
166+
Alternatively, you can install it from source using the command below.
167+
You'll need the latest stable version of the Rust toolchain.
164168

165169
[source,bash]
166170
----
@@ -198,7 +202,8 @@ Emacs support is maintained as part of the https://github.com/emacs-lsp/lsp-mode
198202

199203
=== Vim/NeoVim
200204

201-
Prerequisites: You have installed the <<rust-analyzer-language-server-binary,`rust-analyzer` binary>>. Not needed if the extension can install/update it on its own, coc-rust-analyzer is one example.
205+
Prerequisites: You have installed the <<rust-analyzer-language-server-binary,`rust-analyzer` binary>>.
206+
Not needed if the extension can install/update it on its own, coc-rust-analyzer is one example.
202207

203208
The are several LSP client implementations for vim or neovim:
204209

@@ -270,22 +275,25 @@ Once `neovim/nvim-lspconfig` is installed, use `+lua require'nvim_lsp'.rust_anal
270275

271276
Prerequisites: You have installed the <<rust-analyzer-language-server-binary,`rust-analyzer` binary>>.
272277

273-
You also need the `LSP` package. To install it:
278+
You also need the `LSP` package.
279+
To install it:
274280

275281
1. If you've never installed a Sublime Text package, install Package Control:
276282
* Open the command palette (Win/Linux: `ctrl+shift+p`, Mac: `cmd+shift+p`)
277283
* Type `Install Package Control`, press enter
278284
2. In the command palette, run `Package control: Install package`, and in the list that pops up, type `LSP` and press enter.
279285

280-
Finally, with your Rust project open, in the command palette, run `LSP: Enable Language Server In Project` or `LSP: Enable Language Server Globally`, then select `rust-analyzer` in the list that pops up to enable the rust-analyzer LSP. The latter means that rust-analyzer is enabled by default in Rust projects.
286+
Finally, with your Rust project open, in the command palette, run `LSP: Enable Language Server In Project` or `LSP: Enable Language Server Globally`, then select `rust-analyzer` in the list that pops up to enable the rust-analyzer LSP.
287+
The latter means that rust-analyzer is enabled by default in Rust projects.
281288

282289
If it worked, you should see "rust-analyzer, Line X, Column Y" on the left side of the bottom bar, and after waiting a bit, functionality like tooltips on hovering over variables should become available.
283290

284291
If you get an error saying `No such file or directory: 'rust-analyzer'`, see the <<rust-analyzer-language-server-binary,`rust-analyzer` binary>> section on installing the language server binary.
285292

286293
=== GNOME Builder
287294

288-
GNOME Builder 3.37.1 and newer has native `rust-analyzer` support. If the LSP binary is not available, GNOME Builder can install it when opening a Rust file.
295+
GNOME Builder 3.37.1 and newer has native `rust-analyzer` support.
296+
If the LSP binary is not available, GNOME Builder can install it when opening a Rust file.
289297

290298
== Configuration
291299

@@ -413,8 +421,8 @@ include::./generated_diagnostic.adoc[]
413421

414422
==== Color configurations
415423

416-
It is possible to change the foreground/background color of inlay hints. Just add this to your
417-
`settings.json`:
424+
It is possible to change the foreground/background color of inlay hints.
425+
Just add this to your `settings.json`:
418426

419427
[source,jsonc]
420428
----
@@ -436,7 +444,8 @@ It is possible to change the foreground/background color of inlay hints. Just ad
436444

437445
==== Semantic style customizations
438446

439-
You can customize the look of different semantic elements in the source code. For example, mutable bindings are underlined by default and you can override this behavior by adding the following section to your `settings.json`:
447+
You can customize the look of different semantic elements in the source code.
448+
For example, mutable bindings are underlined by default and you can override this behavior by adding the following section to your `settings.json`:
440449

441450
[source,jsonc]
442451
----
@@ -452,7 +461,9 @@ You can customize the look of different semantic elements in the source code. Fo
452461
----
453462

454463
==== Special `when` clause context for keybindings.
455-
You may use `inRustProject` context to configure keybindings for rust projects only. For example:
464+
You may use `inRustProject` context to configure keybindings for rust projects only.
465+
For example:
466+
456467
[source,json]
457468
----
458469
{
@@ -491,7 +502,8 @@ Or it is possible to specify vars more granularly:
491502
]
492503
```
493504

494-
You can use any valid RegExp as a mask. Also note that a full runnable name is something like *run bin_or_example_name*, *test some::mod::test_name* or *test-mod some::mod*, so it is possible to distinguish binaries, single tests, and test modules with this masks: `"^run"`, `"^test "` (the trailing space matters!), and `"^test-mod"` respectively.
505+
You can use any valid regular expression as a mask.
506+
Also note that a full runnable name is something like *run bin_or_example_name*, *test some::mod::test_name* or *test-mod some::mod*, so it is possible to distinguish binaries, single tests, and test modules with this masks: `"^run"`, `"^test "` (the trailing space matters!), and `"^test-mod"` respectively.
495507

496508
==== Compiler feedback from external commands
497509

0 commit comments

Comments
 (0)