Skip to content

docs/dsp: improve docstrings for effects, filters, library overview#169

Merged
vk2seb merged 10 commits into
mainfrom
seb/dspdoc
May 2, 2026
Merged

docs/dsp: improve docstrings for effects, filters, library overview#169
vk2seb merged 10 commits into
mainfrom
seb/dspdoc

Conversation

@vk2seb
Copy link
Copy Markdown
Member

@vk2seb vk2seb commented May 2, 2026

Some additions to clean up holes in the documentation on existing DSP components:

  • Add an overview of how the DSP library is structured and how different components are connected together.
  • Audit dsp.effects, dsp.delay_effect, dsp.filters, dsp.mix and dsp.oscillators for missing docstrings and populate them.
  • Add a test case for the OnePole filter, as it was missing
  • Parameterize the coefficient type for MatrixMix.

@vk2seb vk2seb merged commit ddf0f73 into main May 2, 2026
27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant