Skip to content

docs: update description#13449

Merged
kgryte merged 3 commits into
developfrom
philipp/drift-stats-base-dists-gumbel-2026-07-13
Jul 13, 2026
Merged

docs: update description#13449
kgryte merged 3 commits into
developfrom
philipp/drift-stats-base-dists-gumbel-2026-07-13

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

Two stats/base/dists/gumbel packages carried single-line docs/metadata drift against the sibling convention. Both are pure documentation edits with no source, test, or behavioral impact.

stats/base/dists/gumbel/mgf

lib/index.js's @module description was in the imperative form "Evaluate the moment-generating function (MGF) for a Gumbel distribution.", out of step with the 14/15 (93%) sibling convention "Gumbel distribution <name>." used by every other member of the namespace. Reworded to "Gumbel distribution moment-generating function (MGF).".

stats/base/dists/gumbel/logcdf

package.json description read "Gumbel distribution logarithm of cumulative distribution function." — missing the parenthesized (CDF) acronym that every sibling function whose name references a common acronym includes (cdf, logpdf, mgf, pdf all follow the <name> (ACRONYM). shape). Appended (CDF).

Related Issues

No.

Questions

No.

Other

Total diff: 2 files, 2 LOC — both docs/metadata.

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 running as a scheduled cross-package API drift-detection routine targeting @stdlib/stats/base/dists/gumbel. Structural and semantic features were extracted across all 15 direct-child packages, deviations from the ≥75% majority pattern were surfaced, and independent reviewer passes validated each candidate as confirmed-drift before any file was edited. All edits are docs/metadata only; no source, test, behavioral, or generator output is touched. A human should audit and promote this PR out of draft.


@stdlib-js/reviewers


Generated by Claude Code

claude added 2 commits July 13, 2026 12:24
Rewords the `lib/index.js` module description from the imperative form
"Evaluate the moment-generating function (MGF) for a Gumbel distribution."
to the noun-phrase form "Gumbel distribution moment-generating function
(MGF).", matching the 14/15 (93%) sibling convention in the
`stats/base/dists/gumbel` namespace. `mgf` was the sole deviator.
…ription

Appends the `(CDF)` acronym to the `package.json` description so it reads
"Gumbel distribution logarithm of cumulative distribution function (CDF).",
matching the sibling convention. Every other `stats/base/dists/gumbel`
package whose name references a common-acronym function (`cdf`, `logpdf`,
`mgf`, `pdf`) already includes the parenthesized acronym in its
`package.json` description; `logcdf` was the sole deviator.
@stdlib-bot stdlib-bot added the Statistics Issue or pull request related to statistical functionality. label Jul 13, 2026
@stdlib-bot

stdlib-bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/gumbel/logcdf $\\color{green}293/293$
$\\color{green}+0.00\\%$
$\\color{green}19/19$
$\\color{green}+0.00\\%$
$\\color{green}4/4$
$\\color{green}+0.00\\%$
$\\color{green}293/293$
$\\color{green}+0.00\\%$

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

Comment thread lib/node_modules/@stdlib/stats/base/dists/gumbel/mgf/lib/index.js Outdated
Co-authored-by: Athan <kgryte@gmail.com>
Signed-off-by: Athan <kgryte@gmail.com>
@kgryte kgryte marked this pull request as ready for review July 13, 2026 22:22
@kgryte kgryte requested a review from a team July 13, 2026 22:22
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jul 13, 2026
@kgryte kgryte changed the title docs: normalize stats/base/dists/gumbel module description drift docs: update description Jul 13, 2026
@kgryte kgryte merged commit c3b1dd3 into develop Jul 13, 2026
31 checks passed
@kgryte kgryte deleted the philipp/drift-stats-base-dists-gumbel-2026-07-13 branch July 13, 2026 22:32
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Jul 13, 2026
MeKaustubh07 pushed a commit to MeKaustubh07/stdlib that referenced this pull request Jul 14, 2026
PR-URL: stdlib-js#13449
Co-authored-by: Athan Reines <kgryte@gmail.com>
Reviewed-by: Athan Reines <kgryte@gmail.com> 
Signed-off-by: Athan Reines <kgryte@gmail.com>
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