aboutsummaryrefslogtreecommitdiff
path: root/docs/user
diff options
context:
space:
mode:
authorAleksey Kladov <[email protected]>2019-10-25 12:16:46 +0100
committerAleksey Kladov <[email protected]>2019-10-25 12:47:48 +0100
commit0dd35ff2b2ceffdb926953fdacc7d30e1968047d (patch)
treea8bcab00ef1c434e56845034f22a5595d119dea7 /docs/user
parent518f99e16b993e3414a81181c8bad7a89e590ece (diff)
auto-generate assists docs and tests
Diffstat (limited to 'docs/user')
-rw-r--r--docs/user/assists.md24
-rw-r--r--docs/user/features.md4
2 files changed, 27 insertions, 1 deletions
diff --git a/docs/user/assists.md b/docs/user/assists.md
new file mode 100644
index 000000000..cb4b0b9fb
--- /dev/null
+++ b/docs/user/assists.md
@@ -0,0 +1,24 @@
1# Assists
2
3## `convert_to_guarded_return`
4
5Replace a large conditional with a guarded return.
6
7```rust
8// BEFORE
9fn main() {
10 <|>if cond {
11 foo();
12 bar();
13 }
14}
15
16// AFTER
17fn main() {
18 if !cond {
19 return;
20 }
21 foo();
22 bar();
23}
24```
diff --git a/docs/user/features.md b/docs/user/features.md
index 8b7a8d7fc..a94b65ad4 100644
--- a/docs/user/features.md
+++ b/docs/user/features.md
@@ -97,11 +97,13 @@ Start `cargo watch` for live error highlighting. Will prompt to install if it's
97 97
98Stop `cargo watch` 98Stop `cargo watch`
99 99
100### Code Actions (Assists) 100### Assists (Code Actions)
101 101
102These are triggered in a particular context via light bulb. We use custom code on 102These are triggered in a particular context via light bulb. We use custom code on
103the VS Code side to be able to position cursor. `<|>` signifies cursor 103the VS Code side to be able to position cursor. `<|>` signifies cursor
104 104
105See [assists.md](./assists.md)
106
105- Add `#[derive]` 107- Add `#[derive]`
106 108
107```rust 109```rust