Skip to content

docs: update parameter type - #15002

Merged
kgryte merged 1 commit into
developfrom
philipp/fix-propagation-2026-09-05
Sep 5, 2026
Merged

docs: update parameter type#15002
kgryte merged 1 commit into
developfrom
philipp/fix-propagation-2026-09-05

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request:

  • propagates fixes merged to develop between c21221c1a (2026-09-04) and 7993e08c4 (2026-09-05) to sibling packages.

Propagated fix: lambda domain in Wald distribution native.js docs

30e3116 ("chore: clean-up") aligned the lambda JSDoc type in @stdlib/stats/base/dists/wald/pdf/lib/native.js with lib/main.js, changing {PositiveNumber} to {NonNegativeNumber}. lambda === 0 is a handled degenerate case; validation rejects only negative values, so pdf's main.js, factory.js, and both JS and C implementations already document and accept a non-negative domain — only native.js lagged 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.js
  • stats/base/dists/wald/logcdf/lib/native.js
  • stats/base/dists/wald/logpdf/lib/native.js

Related Issues

Does this pull request have any related issues?

No.

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

Validation performed before applying the changes:

  • All 39 commits merged to develop in the 24-hour window were reviewed for propagatable fix patterns; candidate patterns from 810e5f590 (int32 overflow), c21221c1a (missing option validation), 42bbbb1d6 (benchmark require path), b04bbafa8 (JSDoc parameter types), 39365ed17 (README copy), and 1d377422c (expired TLS fixtures) were searched across their respective namespaces and yielded zero remaining sites — the repository is already consistent for those patterns.
  • For the surviving pattern, each target site was verified independently twice against the package's lib/main.js, lib/factory.js, JS validation logic, and C implementation (src/main.c), confirming lambda === 0 is an explicitly handled degenerate case at every site.
  • Remaining wald packages (kurtosis, mean, mgf, mode, quantile, skewness, stdev, variance) were checked and are already consistent ({PositiveNumber} there is correct, as validation rejects lambda <= 0).
  • Deliberately excluded: wald/quantile/lib/bisect.js (internal helper invoked only after argument screening), and TypeScript declaration files (TS has no NonNegativeNumber type).

Checklist

Please ensure the following tasks are completed before submitting this pull request.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

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

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
@stdlib-bot stdlib-bot added the Statistics Issue or pull request related to statistical functionality. label Sep 5, 2026
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/wald/cdf $\\color{green}361/361$
$\\color{green}+100.00\\%$
$\\color{green}35/35$
$\\color{green}+100.00\\%$
$\\color{green}4/4$
$\\color{green}+100.00\\%$
$\\color{green}361/361$
$\\color{green}+100.00\\%$
stats/base/dists/wald/logcdf $\\color{green}363/363$
$\\color{green}+100.00\\%$
$\\color{green}35/35$
$\\color{green}+100.00\\%$
$\\color{green}4/4$
$\\color{green}+100.00\\%$
$\\color{green}363/363$
$\\color{green}+100.00\\%$
stats/base/dists/wald/logpdf $\\color{green}329/329$
$\\color{green}+100.00\\%$
$\\color{green}33/33$
$\\color{green}+100.00\\%$
$\\color{green}4/4$
$\\color{green}+100.00\\%$
$\\color{green}329/329$
$\\color{green}+100.00\\%$

The above coverage report was generated for the changes in this PR.

@kgryte kgryte added the Documentation Improvements, additions, or changes to documentation. label Sep 5, 2026
@kgryte
kgryte marked this pull request as ready for review September 5, 2026 21:21
@kgryte
kgryte requested a review from a team September 5, 2026 21:21
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Sep 5, 2026
@kgryte kgryte changed the title chore: align lambda parameter type across stats/base/dists/wald docs: update parameter type Sep 5, 2026
@kgryte
kgryte merged commit d0a642c into develop Sep 5, 2026
66 checks passed
@kgryte
kgryte deleted the philipp/fix-propagation-2026-09-05 branch September 5, 2026 21:21
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Sep 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements, additions, or changes to documentation. Statistics Issue or pull request related to statistical functionality.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants