Some comments regarding documentation

[bkamins]

1. It would be super useful if each of the options and their combinations were presented by example (i.e. to have one data set and on it present all functions with all options enabled/disabled) - I know this is work in progress, but it is really important to have :)
2. In documentation of running it would be good to add a x-link to tapering definition.
3. In documentation of running it is not 100% clear what padding kwarg does. Reading the docs now it would suggest that it will replace NaN in the output if it is present. But I am not sure if it is the intended meaning of the description.
4. In documentation of datastream it is not clear if you write vector you mean AbstractVector and when you write matrix you mean AbstractMatrix.
5. With weights and running when tapering happens it is not 100% clear how weights are processed. Are weights re-weighted to add up to 1 (or slightly less than 1) or not
6. In "When a window is provided weights, is important to normalize those weights." it is not clear if this is a general info, or a requirement of the package. The reason is that many functions in general do not require weights to be normalized, however, maybe this package has some special implementations for some functions that assume they are normalized.

[JeffreySarnoff]

Thank you. This is on point!

[JeffreySarnoff]

remade docs to be intelligible :)

< now to use the docs as specs and provide fuller conformance testing >

[bkamins]

The https://jeffreysarnoff.github.io/WindowedFunctions.jl/dev/#Introducing-Windowed-Functions is awesome.

BTW: you might want to have a look at duckdblabs/db-benchmark#9 and we could discuss how to best add Julia to these benchmarks.

[JeffreySarnoff]

I created a repo for us to use discussing db-benchmark. You should have the invite. When it works as desired, we can move it to wherever it should be.

…

On Tue, Jul 25, 2023 at 9:24 AM Bogumił Kamiński ***@***.***> wrote: The https://jeffreysarnoff.github.io/WindowedFunctions.jl/dev/#Introducing-Windowed-Functions is awesome. BTW: you might want to have a look at duckdblabs/db-benchmark#9 <duckdblabs/db-benchmark#9> and we could discuss how to best add Julia to these benchmarks. — Reply to this email directly, view it on GitHub <#1 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAM2VRSROQ6ICM3Z4QBJP6DXR7CJXANCNFSM6AAAAAA2LEFQXA> . You are receiving this because you commented.Message ID: ***@***.***>

[bkamins]

Excellent. Thank you!
BTW. if you are at JuliaCon2023 we could work on it there.