Better lint config (#25)

PyO3 · Oct 13, 2024 · b513e08 · b513e08
1 parent 6807fe3
commit b513e08
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 4 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -7,13 +7,26 @@ on:
 name: CI
 
 jobs:
-  check:
-    name: Check
+  lint-rust:
+    name: Lint Rust
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: dtolnay/rust-toolchain@stable
-      - run: cargo check
+        with:
+          components: clippy
+      - name: Clippy
+        env:
+          RUSTFLAGS: -D warnings
+        run: cargo clippy --workspace
+      - name: Clippy (all features)
+        env:
+          RUSTFLAGS: -D warnings
+        run: cargo clippy --workspace --all-features
+      - name: Check documentation
+        env:
+          RUSTDOCFLAGS: -D warnings
+        run: cargo doc --workspace --all-features --no-deps --document-private-items
 
   test:
     name: Test Suite

diff --git a/src/lib.rs b/src/lib.rs
@@ -41,7 +41,7 @@ pub struct Project {
     pub requires_python: Option<VersionSpecifiers>,
     /// License
     pub license: Option<License>,
-    /// License Files (PEP 639) - https://peps.python.org/pep-0639/#add-license-files-key
+    /// License Files (PEP 639) - <https://peps.python.org/pep-0639/#add-license-files-key>
     pub license_files: Option<LicenseFiles>,
     /// The people or organizations considered to be the "authors" of the project
     pub authors: Option<Vec<Contact>>,