Merge pull request #128 from rerun-io/john/fix_gen_docs

Small fixes to make clippy happy
baoyachi · Feb 16, 2023 · d4145c5 · d4145c5
2 parents 6179d11 + 0031865
commit d4145c5
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/src/gen_const.rs b/src/gen_const.rs
@@ -61,10 +61,10 @@ build_env:{},{}"#,PKG_VERSION, TAG, SHORT_COMMIT, BUILD_TIME, RUST_VERSION, RUST
 const VERSION_CONST_DESC: &str = r#"/// The common version const. It's so easy to use this const."#;
 
 const CLAP_VERSION_CONST_DESC: &str =
-    r#"/// The common version const. It's so easy to use this const with CLAP_VERSION."#;
+    r#"/// The common version const. It's so easy to use this const with `CLAP_VERSION`."#;
 
 const CLAP_LONG_VERSION_CONST_DESC: &str =
-    r#"/// The common version const. It's so easy to use this const with CLAP_VERSION."#;
+    r#"/// The common version const. It's so easy to use this const with `CLAP_VERSION`."#;
 
 gen_const!(
     version_branch_const,

diff --git a/src/lib.rs b/src/lib.rs
@@ -197,6 +197,7 @@ const SHADOW_RS: &str = "shadow.rs";
 #[macro_export]
 macro_rules! shadow {
     ($build_mod:ident) => {
+        #[doc=r#"shadow-rs mod"#]
         pub mod $build_mod {
             include!(concat!(env!("OUT_DIR"), "/shadow.rs"));
         }
@@ -289,7 +290,7 @@ impl Shadow {
     where
         F: FnOnce(&File) -> SdResult<()>,
     {
-        let desc = r#"/// Below code generated by project custom from by build.rs"#;
+        let desc = r#"//! Below code generated by project custom from by build.rs"#;
         writeln!(&self.f, "\n{desc}\n")?;
         f(&self.f)?;
         Ok(())