Fix documentation error

Kijewski · Sep 14, 2023 · 8edb4ac · 8edb4ac
1 parent a33721b
commit 8edb4ac
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -101,6 +101,21 @@ jobs:
 
       - run: cargo package --package zipsign
 
+  doc:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Rust
+        uses: ./.github/actions/setup-rust
+        with:
+          key: doc
+          toolchain: nightly
+
+      - run: cargo +nightly doc --all-features --no-deps
+        env:
+          RUSTDOCFLAGS: "--cfg docsrs -D warnings"
+
   audit:
     runs-on: ubuntu-latest
     steps:

diff --git a/api/src/sign/zip.rs b/api/src/sign/zip.rs
@@ -8,7 +8,7 @@ use zip::{ZipArchive, ZipWriter};
 use super::{gather_signature_data, prehashed_message, GatherSignatureDataError};
 use crate::{SignatureCountLeInt, SigningKey, BUF_LIMIT, HEADER_SIZE, SIGNATURE_LENGTH};
 
-/// An error returned by [`copy_and_sign()`]
+/// An error returned by [`copy_and_sign_zip()`]
 #[derive(Debug, thiserror::Error)]
 pub enum SignZipError {
     /// Could not read input ZIP