Merge #7961

7961: add user docs for ssr assist r=JoshMcguigan a=JoshMcguigan

@matklad 

This is a small follow up on #7874, adding user docs for the SSR assist functionality. Since most other assists aren't handled this way I wasn't sure exactly how we wanted to document this, so feel free to suggest alternatives.

Co-authored-by: Josh Mcguigan <[email protected]>

1 files changed, 9 insertions, 0 deletions

diff --git a/crates/ide_ssr/src/lib.rs b/crates/ide_ssr/src/lib.rs
index e72c611a3..00585f448 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 from_comment;
 mod matching;