Clarify CI documentation test command

RustAudio · Nov 21, 2024 · 1182681 · 1182681
1 parent 7b70230
commit 1182681
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -49,6 +49,8 @@ jobs:
       - run: cargo test --all-targets
       - run: cargo test --all-targets --features=experimental
       - run: cargo test --all-targets --features=symphonia-all
+      # `cargo test` does not check benchmarks and `cargo test --all-targets` excludes
+      # documentation tests. Therefore, we need an additional docs test command here.
       - run: cargo test --doc
   cargo-publish:
     if: github.event_name == 'push' && github.ref == 'refs/heads/master'