docs: improve JSDoc across 10 files#373
Merged
Merged
Conversation
Member
lpatiny
commented
May 15, 2026
- Add missing JSDoc to zeroShift, matrixAutoCorrelation, matrixBoxPlot
- Document sorted-rows invariant on matrixBoxPlot
- Add interface property docs to MatrixBoxPlot
- Trim verbose xyEquallySpaced prose; fix stub from/to/variant descriptions
- Fix xGetFromToIndex descriptions that wrongly cited xyIntegration; add @default for from/to
- Fix truncated centerX description in xHistogram; add @default for logBaseX/logBaseY/absolute
- Add algorithm property JSDoc and fix stray character in xPadding
- Add zones property JSDoc to XYExtractOptions
- Fix mangled magnitudeMode description in reimAutoPhaseCorrection; add @returns
- Fix copy-pasted wrong descriptions on nbRows/nbColumns in matrixCreateEmpty
- Add missing JSDoc to zeroShift, matrixAutoCorrelation, matrixBoxPlot - Document sorted-rows invariant on matrixBoxPlot - Add interface property docs to MatrixBoxPlot - Trim verbose xyEquallySpaced prose; fix stub from/to/variant descriptions - Fix xGetFromToIndex descriptions that wrongly cited xyIntegration; add @default for from/to - Fix truncated centerX description in xHistogram; add @default for logBaseX/logBaseY/absolute - Add algorithm property JSDoc and fix stray character in xPadding - Add zones property JSDoc to XYExtractOptions - Fix mangled magnitudeMode description in reimAutoPhaseCorrection; add @returns - Fix copy-pasted wrong descriptions on nbRows/nbColumns in matrixCreateEmpty
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #373 +/- ##
=======================================
Coverage 97.15% 97.15%
=======================================
Files 206 206
Lines 4116 4116
Branches 1031 1031
=======================================
Hits 3999 3999
Misses 113 113
Partials 4 4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.