Skip to content

Commit

Permalink
Merge pull request #26 from quartiq/doc
Browse files Browse the repository at this point in the history
biquad: fix doc link
  • Loading branch information
jordens authored Feb 14, 2024
2 parents efbcddd + a60e6a2 commit 9b3f1e2
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
24 changes: 24 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion src/iir/biquad.rs
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ impl<T: Coefficient> Biquad<T> {
/// 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)`.
///
/// ```
Expand Down

0 comments on commit 9b3f1e2

Please sign in to comment.