Skip to content

docs: normalize description in stats/base/dists/exponential/logcdf#12116

Merged
kgryte merged 1 commit into
developfrom
claude/inspiring-curie-CxYj1
May 14, 2026
Merged

docs: normalize description in stats/base/dists/exponential/logcdf#12116
kgryte merged 1 commit into
developfrom
claude/inspiring-curie-CxYj1

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

Aligns the package.json description, lib/index.js JSDoc summary, and README.md blockquote intro for @stdlib/stats/base/dists/exponential/logcdf with the namespace majority pattern.

stats/base/dists/exponential/logcdf

13 of 15 members of @stdlib/stats/base/dists/exponential describe themselves in the form "Exponential distribution X." (86.7% conformance); logcdf and logpdf carry the older "Natural logarithm of X (Y) for an exponential distribution." phrasing. Normalized logcdf to "Exponential distribution logarithm of cumulative distribution function (CDF)." across package.json (description), lib/index.js (JSDoc summary), and README.md (blockquote intro). Same change shape as 5e6cc52 for cosine/{ctor,logcdf}. Metadata only; no source, test, or behavioral change.

Validation

Checked:

  • structural feature extraction (file tree, package.json shape, README section list, manifest.json shape, test/benchmark/example filenames) across all 15 members.
  • semantic feature extraction (public signature, validation prologue, error construction, JSDoc shape, dependency set) across all 15 members by reading each lib/main.js directly.
  • three-agent drift validation:
    • opus semantic-review confirmed the deviation is unintentional and the proposed rephrasing preserves all meaning.
    • opus cross-reference confirmed no test, example, sibling-package documentation, or REPL fixture references the original description string.
    • sonnet structural-review confirmed the proposed text exactly matches the namespace majority and the cosine/logcdf maintainer precedent (5e6cc52).

Deliberately excluded:

  • logpdf was a candidate outlier for the same normalization, but the cross-reference agent returned needs-human: logpdf/docs/types/index.d.ts line 89 reads "Exponential distribution natural logarithm of probability density function (logPDF)." — a partial-migration phrasing that diverges from both the proposed text and the cosine template. Updating only the three precedent files would leave the package internally inconsistent; resolving the type-def expands scope beyond the precedent's shape. Dropped from this run.
  • ctor (no native bindings, JS-only constructor) and logcdf/logpdf (only members with ## Notes README sections) reflect intentional semantic groupings and were excluded from drift detection.
  • Native-bindings file group, gypfile package.json key, lib/factory.js (factory-equipped vs not), and PositiveNumber vs NonNegativeNumber JSDoc typing — each below 75% within-namespace conformance or reflective of genuine semantic differences (e.g. ctor lacks all native bindings).

Related Issues

None.

Questions

No.

Other

Random namespace pick from 122 eligible namespaces in lib/node_modules/@stdlib/ with ≥8 direct child packages (seed 17786601871205, index 54/122). This is the second drift run on @stdlib/stats/base/dists/exponential; the first (#11996, merged 2026-05-08) fixed a C API heading typo in logcdf. Description normalization was not yet a recognized pattern at that time — commit 5e6cc52 (cosine, 2026-05-12) established the precedent.

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 via the cross-package drift-detection routine: structural and semantic features were extracted from every member of @stdlib/stats/base/dists/exponential, majority patterns were computed at a 75% conformance threshold, and three independent validation agents (opus semantic-review, opus cross-reference, sonnet structural-review) confirmed the correction was high-signal mechanical drift before any file was edited. The proposed logpdf correction was dropped because the cross-reference agent returned needs-human over a pre-existing type-def inconsistency. All edits are docs/metadata; no source, test, or behavioral change.


@stdlib-js/reviewers


Generated by Claude Code

Aligns the `package.json` description, `lib/index.js` JSDoc summary, and
`README.md` blockquote intro with the namespace majority pattern
("<Distribution name> <function description>.") used by 13 of 15 members
of `@stdlib/stats/base/dists/exponential` (86.7% conformance). Matches the
maintainer precedent set in 5e6cc52 for `cosine/{ctor,logcdf}`.

Metadata only; no source, test, or behavioral change.
@stdlib-bot stdlib-bot added Statistics Issue or pull request related to statistical functionality. Good First PR A pull request resolving a Good First Issue. labels May 13, 2026
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/exponential/logcdf $\color{green}279/279$
$\color{green}+100.00%$
$\color{green}20/20$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}279/279$
$\color{green}+100.00%$

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

@Planeshifter Planeshifter marked this pull request as ready for review May 13, 2026 20:32
@Planeshifter Planeshifter requested review from a team and kgryte May 13, 2026 20:32
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label May 13, 2026
@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
@kgryte kgryte merged commit f2c2f39 into develop May 14, 2026
90 checks passed
@kgryte kgryte deleted the claude/inspiring-curie-CxYj1 branch May 14, 2026 05:57
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. Good First PR A pull request resolving a Good First Issue. Statistics Issue or pull request related to statistical functionality.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants