Skip to content

docs: fix JSDoc descriptions#12637

Merged
kgryte merged 1 commit into
developfrom
philipp/drift-stats-base-dists-cauchy-2026-06-06
Jun 8, 2026
Merged

docs: fix JSDoc descriptions#12637
kgryte merged 1 commit into
developfrom
philipp/drift-stats-base-dists-cauchy-2026-06-06

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

@stdlib/stats/base/dists/cauchy/logcdf: correct three JSDoc description copy-paste/spacing errors surfaced by a within-namespace majority vote across the 9 members of stats/base/dists/cauchy. lib/index.js's module description was a copy of cdf's description (8/9 = 88.9% of cauchy siblings have an index.js module description that matches their own package.json description field; logcdf was the sole outlier). lib/native.js dropped the word natural from natural logarithm in the function-level description (7/8 = 87.5% of cauchy siblings with a native.js have identical function-level descriptions in main.js and native.js; logcdf was the sole outlier). lib/factory.js line 63 had a double space between the and natural in the inner-function description (4/5 = 80% of cauchy factory.js files use single spacing). All three edits are JSDoc-comment text changes; no source, test, or behavioral changes.

Related Issues

This pull request has no related issues.

Questions

No.

Other

No.

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 stats/base/dists/cauchy, majority patterns were computed at a 75% conformance threshold, and three independent validation agents (opus semantic-review, opus cross-reference, sonnet structural-review) confirmed each correction was high-signal mechanical drift before any file was edited. The diff is three single-line JSDoc-comment edits in logcdf's lib/index.js, lib/native.js, and lib/factory.js.


@stdlib-js/reviewers


Generated by Claude Code

Correct three JSDoc copy-paste/spacing errors surfaced by within-namespace
majority vote across `stats/base/dists/cauchy` (9 members):

- `lib/index.js` module description was a copy of the `cdf` package's
  description; updated to match the package's own `package.json`
  description (8/9 = 88.9% of cauchy siblings have matching
  `index.js`/`package.json` descriptions).
- `lib/native.js` function description dropped the word `natural` from
  `natural logarithm`; restored to match `lib/main.js` (7/8 = 87.5% of
  cauchy siblings with `native.js` have identical descriptions in
  `main.js` and `native.js`).
- `lib/factory.js` line 63 had a double space in the inner-function
  description; collapsed to single space (4/5 = 80% of cauchy
  `factory.js` inner-function descriptions use single spacing).

Documentation only; no source, test, or behavioral changes.
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

No coverage information available.

@stdlib-bot stdlib-bot added the Statistics Issue or pull request related to statistical functionality. label Jun 6, 2026
@Planeshifter Planeshifter marked this pull request as ready for review June 8, 2026 20:11
@Planeshifter Planeshifter requested review from a team and kgryte June 8, 2026 20:11
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jun 8, 2026
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Jun 8, 2026
@kgryte kgryte changed the title docs: fix JSDoc descriptions in @stdlib/stats/base/dists/cauchy/logcdf docs: fix JSDoc descriptions Jun 8, 2026
@kgryte kgryte merged commit 8d60f41 into develop Jun 8, 2026
71 checks passed
@kgryte kgryte deleted the philipp/drift-stats-base-dists-cauchy-2026-06-06 branch June 8, 2026 20:43
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