Filters.PolynomialRatio docs mention continuous-time case in description, but not {:s}

JuliaDSP / DSP.jl

Filter design, periodograms, window functions, and other digital signal processing functionality

https://docs.juliadsp.org/stable/contents/

Other

375 stars 109 forks source link

Open dnadlinger opened 2 years ago

dnadlinger commented 2 years ago

Currently, https://docs.juliadsp.org/stable/filters/#DSP.Filters.PolynomialRatio shows the two definitions for a rational transfer function in the s and z domains. However, the syntax needed to use the continuous-time case, the :s type parameter, isn't mentioned anywhere.

This is quite confusing, especially since the continuous-time case is mentioned first in the description.

martinholters commented 2 years ago

Completely agree. I just missed to properly update the documentation in #284.