Fix a rustdoc::all warning

roadster-rs · Mar 29, 2024 · 60b6a49 · 60b6a49
1 parent f8cfd9c
commit 60b6a49
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/.cargo-husky/hooks/pre-push b/.cargo-husky/hooks/pre-push
@@ -8,7 +8,7 @@ echo "### fmt --all --check ###"
 cargo fmt --all --check
 
 echo "### cargo doc --all-features --no-deps ###"
-RUSTDOCFLAGS="-D warnings" cargo doc --all-features --no-deps
+RUSTDOCFLAGS="-D rustdoc::all" cargo doc --all-features --no-deps
 
 # With no features
 echo "### test --no-default-features --workspace ###"

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -38,5 +38,5 @@ jobs:
       - uses: actions/checkout@v4
       - name: Docs
         env:
-          RUSTDOCFLAGS: "-D rustdoc::all -A rustdoc::private-doc-tests"
+          RUSTDOCFLAGS: "-D rustdoc::all"
         run: cargo doc --all-features --no-deps
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,3 +1,7 @@
+//! # Roadster
+//!
+//! Todo: Add documentation
+
 #![forbid(unsafe_code)]
 
 pub mod app;