Merge #3275

3275: Add Structural Search and Replace doc r=matklad a=adamrk

Addresses the first point of https://github.com/rust-analyzer/rust-analyzer/issues/3186.

Co-authored-by: adamrk <[email protected]>
Co-authored-by: Adam Bratschi-Kaye <[email protected]>

1 files changed, 15 insertions, 0 deletions

diff --git a/docs/user/features.md b/docs/user/features.md
index a9cff34d2..48c63ba7b 100644
--- a/docs/user/features.md
+++ b/docs/user/features.md
@@ -105,6 +105,21 @@ Start `cargo watch` for live error highlighting. Will prompt to install if it's
 
 Stop `cargo watch`.
 
+#### Structural Seach and Replace 
+
+Search and replace with named wildcards that will match any expression. 
+The syntax for a structural search replace command is `<search_pattern> ==>> <replace_pattern>`. A `$<name>:expr` placeholder in the search pattern will match any expression and `$<name>` will reference it in the replacement. Available via the command `rust-analyzer.ssr`.
+
+```rust
+// Using structural search replace command [foo($a:expr, $b:expr) ==>> ($a).foo($b)]
+
+// BEFORE
+String::from(foo(y + 5, z))
+
+// AFTER
+String::from((y + 5).foo(z))
+```
+
 ### Assists (Code Actions)
 
 Assists, or code actions, are small local refactorings, available in a particular context.