Merge #2095

2095: move all assists to use generated docs r=matklad a=matklad



Co-authored-by: Aleksey Kladov <[email protected]>

2 files changed, 31 insertions, 5 deletions

diff --git a/crates/ra_assists/src/assists/add_import.rs b/crates/ra_assists/src/assists/add_import.rs
index c522d6a5a..e87fae1af 100644
--- a/crates/ra_assists/src/assists/add_import.rs
+++ b/crates/ra_assists/src/assists/add_import.rs
@@ -1,5 +1,3 @@
-//! FIXME: write short doc here
-
 use hir::{self, db::HirDatabase};
 use ra_syntax::{
     ast::{self, NameOwner},
@@ -14,9 +12,9 @@ use crate::{
     AssistId,
 };
 
-// This function produces sequence of text edits into edit
-// to import the target path in the most appropriate scope given
-// the cursor position
+/// This function produces sequence of text edits into edit
+/// to import the target path in the most appropriate scope given
+/// the cursor position
 pub fn auto_import_text_edit(
     // Ideally the position of the cursor, used to
     position: &SyntaxNode,
@@ -39,6 +37,19 @@ pub fn auto_import_text_edit(
     }
 }
 
+// Assist: add_import
+//
+// Adds a use statement for a given fully-qualified path.
+//
+// ```
+// fn process(map: std::collections::<|>HashMap<String, String>) {}
+// ```
+// ->
+// ```
+// use std::collections::HashMap;
+//
+// fn process(map: HashMap<String, String>) {}
+// ```
 pub(crate) fn add_import(ctx: AssistCtx<impl HirDatabase>) -> Option<Assist> {
     let path: ast::Path = ctx.find_node_at_offset()?;
     // We don't want to mess with use statements
diff --git a/crates/ra_assists/src/doc_tests/generated.rs b/crates/ra_assists/src/doc_tests/generated.rs
index ebe49aecf..1bee76f59 100644
--- a/crates/ra_assists/src/doc_tests/generated.rs
+++ b/crates/ra_assists/src/doc_tests/generated.rs
@@ -142,6 +142,21 @@ impl T for () {
 }
 
 #[test]
+fn doctest_add_import() {
+    check(
+        "add_import",
+        r#####"
+fn process(map: std::collections::<|>HashMap<String, String>) {}
+"#####,
+        r#####"
+use std::collections::HashMap;
+
+fn process(map: HashMap<String, String>) {}
+"#####,
+    )
+}
+
+#[test]
 fn doctest_apply_demorgan() {
     check(
         "apply_demorgan",