Skip to content

docs: improve JSDoc across 10 files#373

Merged
lpatiny merged 1 commit into
mainfrom
jsdoc-improvements
May 15, 2026
Merged

docs: improve JSDoc across 10 files#373
lpatiny merged 1 commit into
mainfrom
jsdoc-improvements

Conversation

@lpatiny
Copy link
Copy Markdown
Member

@lpatiny 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
@lpatiny lpatiny enabled auto-merge (squash) May 15, 2026 12:52
@lpatiny lpatiny merged commit d20f32f into main May 15, 2026
8 checks passed
@lpatiny lpatiny deleted the jsdoc-improvements branch May 15, 2026 12:52
@codecov
Copy link
Copy Markdown

codecov Bot commented May 15, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.15%. Comparing base (fdd4414) to head (291e407).
⚠️ Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant