diff --git a/include/bw_iir1.h b/include/bw_iir1.h index e5e4e31..5f78ffc 100644 --- a/include/bw_iir1.h +++ b/include/bw_iir1.h @@ -23,7 +23,13 @@ * version {{{ 1.0.0 }}} * requires {{{ bw_common bw_math }}} * description {{{ - * XXX + * Lightweight and fast first-order IIR filter in TDF-II form. + * + * This is not a regular DSP module, as it exposes state and coefficients, + * and it's not appropriate for time-varying operation. If you need that, + * check out [bw_ap1](bw_ap1), [bw_hp1](bw_hp1), [bw_hs1](bw_hs1), + * [bw_lp1](bw_lp1), [bw_ls1](bw_ls1), [bw_mm1](bw_mm1), and + * [bw_one_pole](bw_one_pole). * }}} * changelog {{{ *