From 8965dc2bc3d72672a62015668058791e856c5379 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20J=C3=B6rdens?= Date: Wed, 14 Feb 2024 17:26:25 +0100 Subject: [PATCH 1/2] biquad: fix doc link --- src/iir/biquad.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/iir/biquad.rs b/src/iir/biquad.rs index 4450913..d225646 100644 --- a/src/iir/biquad.rs +++ b/src/iir/biquad.rs @@ -213,7 +213,7 @@ impl Biquad { /// Filter coefficients /// /// IIR filter tap gains (`ba`) are an array `[b0, b1, b2, a1, a2]` such that - /// [`Biquad::update(&mut xy, x0)`] returns + /// [`Biquad::update()`] returns /// `y0 = clamp(b0*x0 + b1*x1 + b2*x2 - a1*y1 - a2*y2 + u, min, max)`. /// /// ``` From a60e6a29f9b2b1ced7c68dad758e6eefb1c537be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20J=C3=B6rdens?= Date: Wed, 14 Feb 2024 17:29:47 +0100 Subject: [PATCH 2/2] add doc to ci --- .github/workflows/ci.yml | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 5d759ee..7a78820 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -53,3 +53,27 @@ jobs: uses: actions-rs/cargo@v1 with: command: bench + + doc: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions-rs/toolchain@v1 + with: + toolchain: stable + - uses: Swatinem/rust-cache@v1 + - uses: actions-rs/cargo@v1 + with: + command: install + args: | + cargo-deadlinks + - name: cargo doc + uses: actions-rs/cargo@v1 + with: + command: doc + args: --no-deps + - name: cargo deadlinks + uses: actions-rs/cargo@v1 + with: + command: deadlinks + args: --ignore-fragments --check-intra-doc-links