docs: update parameter type - #15002
Merged
Merged
Conversation
Propagates fix from 30e3116 ("chore: clean-up"), which aligned the `lambda` JSDoc parameter type in `wald/pdf/lib/native.js` with `lib/main.js`, to the sibling packages whose `native.js` still documents `lambda` as `{number}` while `main.js` and the underlying implementations document and accept a non-negative shape parameter (`lambda === 0` is a handled degenerate case): - stats/base/dists/wald/cdf - stats/base/dists/wald/logcdf - stats/base/dists/wald/logpdf Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QpSMAc3bMjNLZnyKm6WXbt
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
marked this pull request as ready for review
September 5, 2026 21:21
kgryte
approved these changes
Sep 5, 2026
lambda parameter type across stats/base/dists/wald
7 tasks
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.
Description
This pull request:
developbetweenc21221c1a(2026-09-04) and7993e08c4(2026-09-05) to sibling packages.Propagated fix:
lambdadomain in Wald distributionnative.jsdocs30e3116 ("chore: clean-up") aligned the
lambdaJSDoc type in@stdlib/stats/base/dists/wald/pdf/lib/native.jswithlib/main.js, changing{PositiveNumber}to{NonNegativeNumber}.lambda === 0is a handled degenerate case; validation rejects only negative values, sopdf'smain.js,factory.js, and both JS and C implementations already document and accept a non-negative domain — onlynative.jslagged with the stricter positive-only type. The same mismatch exists in the sibling Wald distribution functions and needs the identical one-line correction:stats/base/dists/wald/cdf/lib/native.jsstats/base/dists/wald/logcdf/lib/native.jsstats/base/dists/wald/logpdf/lib/native.jsRelated Issues
No.
Questions
No.
Other
Validation performed before applying the changes:
developin the 24-hour window were reviewed for propagatable fix patterns; candidate patterns from810e5f590(int32 overflow),c21221c1a(missing option validation),42bbbb1d6(benchmark require path),b04bbafa8(JSDoc parameter types),39365ed17(README copy), and1d377422c(expired TLS fixtures) were searched across their respective namespaces and yielded zero remaining sites — the repository is already consistent for those patterns.lib/main.js,lib/factory.js, JS validation logic, and C implementation (src/main.c), confirminglambda === 0is an explicitly handled degenerate case at every site.waldpackages (kurtosis,mean,mgf,mode,quantile,skewness,stdev,variance) were checked and are already consistent ({PositiveNumber}there is correct, as validation rejectslambda <= 0).wald/quantile/lib/bisect.js(internal helper invoked only after argument screening), and TypeScript declaration files (TS has noNonNegativeNumbertype).Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code as part of an automated fix-propagation routine: it identified the source commit, located sibling packages with the same documentation mismatch, and applied the equivalent one-line fixes after multi-pass automated validation.
@stdlib-js/reviewers
🤖 Generated with Claude Code
https://claude.ai/code/session_01QpSMAc3bMjNLZnyKm6WXbt
Generated by Claude Code