Skip to content

docs: propagate description and example fixes in stats/base/dists/*#12132

Merged
kgryte merged 3 commits into
developfrom
philipp/fix-propagation-2026-05-14
May 14, 2026
Merged

docs: propagate description and example fixes in stats/base/dists/*#12132
kgryte merged 3 commits into
developfrom
philipp/fix-propagation-2026-05-14

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Propagating fixes merged to develop between 2026-05-13 20:52 PDT (360877d) and 2026-05-14 02:11 PDT (80b1ef7) to sibling packages.

Description

stats/base/dists/{gamma,pareto-type1}/pdf

Propagates the double-space collapse from 4728aa8 to two additional package.json description fields that contain the same defect: an errant double space between the distribution name and the word "distribution". Both packages are updated to be consistent with the fix applied in the source commit.

  • lib/node_modules/@stdlib/stats/base/dists/gamma/pdf
  • lib/node_modules/@stdlib/stats/base/dists/pareto-type1/pdf

stats/base/dists/{lognormal,rayleigh}/*

Propagates the sigma lower-bound fix from 3220a54 to 17 sibling C example files. Prior to that fix, sigma was generated from [0.0, upper], allowing a value of 0.0 which falls outside the strictly-positive support required by both lognormal and rayleigh distributions; the lower bound is raised to 0.1 to guarantee a valid scale parameter.

  • lognormal/{mode,variance,skewness,mean,stdev,entropy,median}
  • rayleigh/{pdf,mode,variance,kurtosis,cdf,mean,entropy,logcdf,logpdf,median}

stats/base/dists/{discrete-uniform,pareto-type1}/logcdf

Propagates the description normalization from f2c2f39 to two sibling logcdf packages, aligning the README tagline, JSDoc @module summary, and package.json description to the canonical form "<DistName> distribution logarithm of cumulative distribution function (CDF).". As a side effect, this fixes the pre-existing CDF)for missing-space typo in both package.json files.

  • lib/node_modules/@stdlib/stats/base/dists/discrete-uniform/logcdf
  • lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf

Related Issues

None.

Questions

None.

Other

Validation

Audited the 24-hour window (360877d..80b1ef7, 15 first-parent commits) for propagable fix patterns. Three patterns surfaced: the double-space collapse from 4728aa8, the sigma lower-bound fix from 3220a54, and the logcdf description normalization from f2c2f39. Search was scoped to sibling packages under stats/base/dists/*. Two independent validators read each candidate site in full and confirmed the defect; an adaptation pass produced per-site patches for the description-normalization pattern; a style-consistency pass reviewed each proposed patch.

Items deliberately excluded:

  • Four logcdf packages (t, normal, lognormal, kumaraswamy) where the source rewrite is not a clean substitution — t/logcdf and kumaraswamy/logcdf introduce extra phrasing ("(CDF)" parenthetical, leading "Evaluate" verb), and normal/logcdf / lognormal/logcdf READMEs do not wrap "cumulative distribution function" in a reference link. Flagged for human review by the validation pass.
  • Sigma-bound propagation to non-positive-scale distributions (no sites — normal was the source; lognormal and rayleigh are the only siblings whose C examples generate sigma = random_uniform( 0.0, ... )).
  • The numpy.nans keyword removal from 65cbb12 — no sibling package.json files reference numpy.nans.
  • Source commits classified as feature additions (feat:), namespace/ToC updates, or chores touching only package.json keywords (00769bf) — none carry a propagable defect pattern.

Checklist

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 daily propagation pass over commits merged to develop. Each propagation site was independently verified by two validators reading the target file in full, an adaptation pass produced per-site patches where the source fix was not verbatim-applicable, and a style-consistency pass reviewed the resulting changes before they were applied. The PR is being opened as a draft for human audit; please do not promote to ready-for-review until the changes have been confirmed.



Generated by Claude Code

claude added 3 commits May 14, 2026 13:23
…}/pdf` descriptions

Propagates fix from 4728aa8 ("docs: collapse double spaces in `strided/napi/{binary,smskmap,unary}`") to sibling distribution PDF packages whose `package.json` descriptions contained a stray double space.
…mal/*` and `rayleigh/*`

Propagates fix from 3220a54 ("chore: propagate `ndarray/*` and `normal/*` fixes") to the C examples for sibling positive-scale distributions, raising the sigma lower bound from `0.0` to `0.1` so generated values stay within the strictly-positive domain.
…reto-type1}/logcdf`

Propagates fix from f2c2f39 ("docs: normalize description in `stats/base/dists/exponential/logcdf`") to sibling `logcdf` packages, rewriting the README tagline, JSDoc summary, and `package.json` description into the canonical "<DistName> distribution logarithm of cumulative distribution function (CDF)." form (incidentally fixing the pre-existing missing-space typo `CDF)for` in both `package.json` files).
@stdlib-bot stdlib-bot added the Statistics Issue or pull request related to statistical functionality. label May 14, 2026
@Planeshifter Planeshifter marked this pull request as ready for review May 14, 2026 13:40
@Planeshifter Planeshifter requested review from a team and kgryte May 14, 2026 13:40
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label May 14, 2026
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/discrete-uniform/logcdf $\color{green}305/305$
$\color{green}+100.00%$
$\color{green}31/31$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}305/305$
$\color{green}+100.00%$
stats/base/dists/gamma/pdf $\color{red}486/538$
$\color{green}+90.33%$
$\color{red}40/49$
$\color{green}+81.63%$
$\color{green}6/6$
$\color{green}+100.00%$
$\color{red}486/538$
$\color{green}+90.33%$
stats/base/dists/lognormal/entropy $\color{green}178/178$
$\color{green}+100.00%$
$\color{green}9/9$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}178/178$
$\color{green}+100.00%$
stats/base/dists/lognormal/mean $\color{green}176/176$
$\color{green}+100.00%$
$\color{green}9/9$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}176/176$
$\color{green}+100.00%$
stats/base/dists/lognormal/median $\color{green}176/176$
$\color{green}+100.00%$
$\color{green}9/9$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}176/176$
$\color{green}+100.00%$
stats/base/dists/lognormal/mode $\color{green}176/176$
$\color{green}+100.00%$
$\color{green}9/9$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}176/176$
$\color{green}+100.00%$
stats/base/dists/lognormal/skewness $\color{green}179/179$
$\color{green}+100.00%$
$\color{green}9/9$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}179/179$
$\color{green}+100.00%$
stats/base/dists/lognormal/stdev $\color{green}169/169$
$\color{green}+100.00%$
$\color{green}5/5$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}169/169$
$\color{green}+100.00%$
stats/base/dists/lognormal/variance $\color{green}178/178$
$\color{green}+100.00%$
$\color{green}9/9$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}178/178$
$\color{green}+100.00%$
stats/base/dists/pareto-type1/logcdf $\color{green}327/327$
$\color{green}+100.00%$
$\color{green}25/25$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}327/327$
$\color{green}+100.00%$
stats/base/dists/pareto-type1/pdf $\color{red}336/339$
$\color{green}+99.11%$
$\color{green}24/24$
$\color{green}+100.00%$
$\color{red}3/4$
$\color{green}+75.00%$
$\color{red}336/339$
$\color{green}+99.11%$
stats/base/dists/rayleigh/cdf $\color{green}288/288$
$\color{green}+100.00%$
$\color{green}27/27$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}288/288$
$\color{green}+100.00%$
stats/base/dists/rayleigh/entropy $\color{green}164/164$
$\color{green}+100.00%$
$\color{green}8/8$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}164/164$
$\color{green}+100.00%$
stats/base/dists/rayleigh/kurtosis $\color{green}175/175$
$\color{green}+100.00%$
$\color{green}8/8$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}175/175$
$\color{green}+100.00%$
stats/base/dists/rayleigh/logcdf $\color{green}302/302$
$\color{green}+100.00%$
$\color{green}31/31$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}302/302$
$\color{green}+100.00%$
stats/base/dists/rayleigh/logpdf $\color{green}297/297$
$\color{green}+100.00%$
$\color{green}29/29$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}297/297$
$\color{green}+100.00%$
stats/base/dists/rayleigh/mean $\color{green}162/162$
$\color{green}+100.00%$
$\color{green}8/8$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}162/162$
$\color{green}+100.00%$
stats/base/dists/rayleigh/median $\color{green}166/166$
$\color{green}+100.00%$
$\color{green}8/8$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}166/166$
$\color{green}+100.00%$
stats/base/dists/rayleigh/mode $\color{green}161/161$
$\color{green}+100.00%$
$\color{green}8/8$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}161/161$
$\color{green}+100.00%$
stats/base/dists/rayleigh/pdf $\color{green}295/295$
$\color{green}+100.00%$
$\color{green}29/29$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}295/295$
$\color{green}+100.00%$
stats/base/dists/rayleigh/variance $\color{green}162/162$
$\color{green}+100.00%$
$\color{green}8/8$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}162/162$
$\color{green}+100.00%$

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

@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels May 14, 2026

/**
* Natural logarithm of the cumulative distribution function (CDF) for a discrete uniform distribution.
* Discrete uniform distribution logarithm of cumulative distribution function (CDF).
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not wholly convinced that this is actually a better/preferred description practice. It reads more awkwardly than what we had before.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is based on "Discrete uniform distribution cumulative distribution function" which does read fine. Once you start throwing in other qualifiers, it starts straining the English language, making an awkward construction.

@kgryte kgryte merged commit b517ce1 into develop May 14, 2026
73 checks passed
@kgryte kgryte deleted the philipp/fix-propagation-2026-05-14 branch May 14, 2026 18:46
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