From 40587b08a0e0513d06eeffa9eeee9a78ac23100d Mon Sep 17 00:00:00 2001
From: Josh Mcguigan <joshmcg88@gmail.com>
Date: Wed, 10 Mar 2021 08:11:16 -0800
Subject: add user docs for ssr assist

---
 crates/ide_ssr/src/lib.rs | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'crates')

diff --git a/crates/ide_ssr/src/lib.rs b/crates/ide_ssr/src/lib.rs
index a97fc8bca..b894d326e 100644
--- a/crates/ide_ssr/src/lib.rs
+++ b/crates/ide_ssr/src/lib.rs
@@ -57,6 +57,15 @@
 //
 // | VS Code | **Rust Analyzer: Structural Search Replace**
 // |===
+//
+// Also available as an assist, by writing a comment containing the structural
+// search and replace rule. You will only see the assist if the comment can
+// be parsed as a valid structural search and replace rule.
+//
+// ```rust
+// // Place the cursor on the line below to see the assist 💡.
+// // foo($a, $b) ==>> ($a).foo($b)
+// ```
 
 mod matching;
 mod nester;
-- 
cgit v1.2.3