search

fslaborg / FSharp.Stats

statistical testing, linear algebra, machine learning, fitting and signal processing in F#
https://fslab.org/FSharp.Stats/
Other
205 stars 54 forks source link

Xml doc comments and tests for three dimensional padding and discrete… #304

Closed OwenMadden closed 9 months ago

OwenMadden commented 9 months ago

… PadZero.

Thank you for contributing to FSharp.Stats. Please take the time to tell us a bit more about your PR.

Part of feature #281

Please list the changes introduced in this PR Description

Added xml documentation and examples for three dimensional pad function. Added tests for the examples.

Added xml documentation and examples for disrete padZero function. Added tests for the examples.

Fixed a typo in the documented usage where the number of padded point was incorrect.

[Required] please make sure you checked that

[Optional]

codecov-commenter commented 9 months ago

Codecov Report

Merging #304 (1611c0f) into developer (6014323) will increase coverage by 0.11%. Report is 4 commits behind head on developer. The diff coverage is 100.00%.

@@              Coverage Diff              @@
##           developer     #304      +/-   ##
=============================================
+ Coverage      46.31%   46.42%   +0.11%     
=============================================
  Files            148      148              
  Lines          16049    16082      +33     
  Branches        2176     2181       +5     
=============================================
+ Hits            7433     7466      +33     
  Misses          7968     7968              
  Partials         648      648
Files Coverage Δ
src/FSharp.Stats/Signal/Padding.fs 0.00% <ø> (ø)
tests/FSharp.Stats.Tests/Signal.fs 98.70% <100.00%> (+0.35%) :arrow_up:
bvenn commented 9 months ago

Thanks for your contribution @OwenMadden :heavy_check_mark: