Merge #1937

1937: Added test for check doc strings in directory crates/ r=andreevlex a=andreevlex

#1856 

Co-authored-by: Alexander Andreev <[email protected]>

5 files changed, 11 insertions, 1 deletions

diff --git a/crates/ra_tools/src/bin/pre-commit.rs b/crates/ra_tools/src/bin/pre-commit.rs
index a628f64b2..16bbf9cb2 100644
--- a/crates/ra_tools/src/bin/pre-commit.rs
+++ b/crates/ra_tools/src/bin/pre-commit.rs
@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use std::process::Command;
 
 use ra_tools::{project_root, run, run_rustfmt, Overwrite, Result};
diff --git a/crates/ra_tools/src/boilerplate_gen.rs b/crates/ra_tools/src/boilerplate_gen.rs
index 1d112c0af..39f1cae66 100644
--- a/crates/ra_tools/src/boilerplate_gen.rs
+++ b/crates/ra_tools/src/boilerplate_gen.rs
@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 use std::{
     collections::BTreeMap,
     fs,
@@ -282,7 +284,7 @@ fn reformat(text: impl std::fmt::Display) -> Result<String> {
     let output = rustfmt.wait_with_output()?;
     let stdout = String::from_utf8(output.stdout)?;
     let preamble = "Generated file, do not edit by hand, see `crate/ra_tools/src/codegen`";
-    Ok(format!("// {}\n\n{}", preamble, stdout))
+    Ok(format!("//! {}\n\n{}", preamble, stdout))
 }
 
 #[derive(Deserialize, Debug)]
diff --git a/crates/ra_tools/src/help.rs b/crates/ra_tools/src/help.rs
index 9eb4dfbe4..72dfabacd 100644
--- a/crates/ra_tools/src/help.rs
+++ b/crates/ra_tools/src/help.rs
@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 pub const GLOBAL_HELP: &str = "tasks
 
 USAGE:
diff --git a/crates/ra_tools/src/lib.rs b/crates/ra_tools/src/lib.rs
index 9ba23caaa..aa993a38a 100644
--- a/crates/ra_tools/src/lib.rs
+++ b/crates/ra_tools/src/lib.rs
@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 mod boilerplate_gen;
 
 use std::{
diff --git a/crates/ra_tools/src/main.rs b/crates/ra_tools/src/main.rs
index a951ce427..161871ccf 100644
--- a/crates/ra_tools/src/main.rs
+++ b/crates/ra_tools/src/main.rs
@@ -1,3 +1,5 @@
+//! FIXME: write short doc here
+
 mod help;
 
 use core::fmt::Write;