No examples in the documentation

[ufechner7]

If you do not know the DSP functions from Matlab or SciPy already this library is nearly unusable because no examples are provided.

[martinholters]

Help on improving the documentation is always welcome.

[ufechner7]

You can find some examples at https://github.com/aenarete/DiscreteFilters.jl/tree/main/examples

[jclsn]

@martinholters In order to improve the documentation you have to first understand it. That is like telling someone to write a math book, because he doesn't understand math.

I have been staring at this documentation the whole day now and I am still confused about many things. A few easy to follow examples would be great like:

1. Design an FIR filter, preferably Parks-McClellan/Remez
2. Design an IIR filter, e.g. Butterworth
3. Plot the filters using common plotting libraries like Plots and Makie for various design flows

[mbaz]

Shameless plug: for plotting DSP types, there are some recipes for Gaston here: https://github.com/mbaz/GastonDSP.jl

[jclsn]

@mbaz Looks nice. I am more of a Makie fan, but this is definitely usable. No dark theme though it seems. Would have to set all colors manually

[mbaz]

@jclsn If you put together some dark-themed recipes, I'd welcome a PR 😅

[jclsn]

@mbaz I totally love the Spaceduck colors

Tried making a Makie theme, but not couldn't pass the CI etc and didn't bother enough to fix it:

https://github.com/jclsn/SpaceDuck.jl/blob/c40caf855d2530cd735fb2e639622c76c8907e69/src/SpaceDuck.jl#L6

Anyway, offtopic...

This repo totally needs more examples!