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

Add doctest to Xcorr #520

Closed ErikBuer closed 8 months ago

ErikBuer commented 9 months ago

Hi.

As this is my first PR for the project, I figured I'd make it small, just to get through the process.

The PR adds a doctest to the xcorr function. When running the doctest, I noticed some other tests failing, so I corrected the output such that all tests passed. There are also some small linter corrections in the markdown file.

I could not find any developer instructions for the project? It could also be nice with some defined scope, what is the goal, and so on.

I prefer doctests, because these add examples that let the users play around with a working example. If this is something that resonates, I may go over and make some examples, as I see a lot of functions lacking examples.

codecov-commenter commented 8 months ago

Codecov Report

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

:exclamation: No coverage uploaded for pull request base (master@27fdc1f). Click here to learn what that means.

:exclamation: Current head d2bfd3e differs from pull request most recent head 6c9f2b0. Consider uploading reports for the commit 6c9f2b0 to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #520 +/- ## ========================================= Coverage ? 97.46% ========================================= Files ? 18 Lines ? 3080 Branches ? 0 ========================================= Hits ? 3002 Misses ? 78 Partials ? 0 ```

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

ViralBShah commented 8 months ago

Good to merge - perhaps after the docs 1.0 PR?

ViralBShah commented 8 months ago

@ErikBuer Generally many Julia packages do not have well-defined scope, but it tends to be defined by the current set of maintainers (a list which does change and it's always great to bring new people in to drive a project forward). Major deviations or change in directions are often discussed on discourse first (for example, should funcitonality be in multiple packages).

ViralBShah commented 8 months ago

@wheeheee This seems good to merge.