search

JuliaDSP / DSP.jl

Filter design, periodograms, window functions, and other digital signal processing functionality
https://docs.juliadsp.org/stable/contents/
Other
381 stars 109 forks source link

Adding documentation for bilinear function #527

Closed anchal-physics closed 8 months ago

anchal-physics commented 8 months ago

This addresses https://github.com/JuliaDSP/DSP.jl/issues/518

This PR adds documentation for the bilinear function in the Filters module. docstrings are added in source code for the two methods of bilinear function with the top level method explained in detail to providde a clear explanation of what the transform function is doing.

The bilinear function is also added to the export list in Filters.jl so that it is available for Documenter and also for users to use.

The documentation is added to the docs/src/filters.md file in the Filters module, Filter design section where the bilinear function is added as a general digital filter design method.

No code has been changed in this PR, only documentation has been added and an extra function has been added to the export list.

codecov[bot] commented 8 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (3ad3c1c) 97.49% compared to head (4e64302) 97.49%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #527 +/- ## ======================================= Coverage 97.49% 97.49% ======================================= Files 18 18 Lines 3078 3078 ======================================= Hits 3001 3001 Misses 77 77 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

wheeheee commented 8 months ago

Sorry @anchal-physics, could you rebase on master and resolve the conflicts? @martinholters do the formulae look good to you?

ViralBShah commented 8 months ago

I resolved the conflict. I wonder if we should tag a 0.8 release in the next couple of weeks or so.

If someone can review this and merge, that will be great to get into the new release (but of course it is a doc change and can also happen any time).