Repository navigation
docs: normalize @module summaries in stats/base/dists/pareto-type1/{pdf,logpdf} - #13495
Closed
Planeshifter wants to merge 2 commits into
Closed
Planeshifter wants to merge 2 commits into
Planeshifter wants to merge 2 commits into
Conversation
…pe1/pdf`
Rewrite the `@module` JSDoc docblock summary in `lib/index.js` from the
verb form ("Evaluate the probability density function (PDF) for a Pareto
(Type I) distribution.") to the noun form ("Pareto (Type I) distribution
probability density function (PDF)."). Matches the convention used by
11/13 sibling packages in the `stats/base/dists/pareto-type1` namespace
(84.6% conformance) and by `cdf`/`logcdf` word-for-word. Docs-only; the
function-level description in `lib/main.js`, the `docs/repl.txt`
alias entry, and the `docs/types/index.d.ts` summary are unchanged.
…pe1/logpdf`
Rewrite the `@module` JSDoc docblock summary in `lib/index.js` from the
verb form ("Evaluate the natural logarithm of the probability density
function (PDF) for a Pareto (Type I) distribution.") to the noun form
("Pareto (Type I) distribution natural logarithm of probability density
function (PDF)."). Matches the convention used by 11/13 sibling packages
in the `stats/base/dists/pareto-type1` namespace (84.6% conformance) and
parallels `logcdf`'s summary construction. Docs-only; the function-level
description in `lib/main.js`, the `docs/repl.txt` alias entry, and the
`docs/types/index.d.ts` summary are unchanged.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Normalizes the
@moduleJSDoc docblock summaries in thelib/index.jsfiles of twostats/base/dists/pareto-type1sibling packages from the verb-form phrasing (Evaluate the ... for a Pareto (Type I) distribution.) to the noun-form phrasing (Pareto (Type I) distribution ...) used by the remaining 11/13 siblings (84.6% conformance).stats/base/dists/pareto-type1/pdfRewrote the
@modulesummary inlib/index.jsfrom the verb form ("Evaluate the probability density function...") to the noun form ("Pareto (Type I) distribution probability density function (PDF)."). This matches 11 of 13 sibling packages understats/base/dists/pareto-type1(84.6% conformance, excluding the out-of-scopectorconstructor), and mirrorscdf/lib/index.jsline 22 word for word. No other files touched —lib/main.js,docs/repl.txt, anddocs/types/index.d.tskeep their existing phrasing.stats/base/dists/pareto-type1/logpdfRewrote
lib/index.jsline 22 from the verb form to the noun form: "Pareto (Type I) distribution natural logarithm of probability density function (PDF)." This matches 11 of 13 sibling packages understats/base/dists/pareto-type1(excludingctor), or 84.6% conformance, well past the 75% threshold, and mirrorslogcdf/lib/index.jsline 22 exactly in structure.lib/main.js,docs/repl.txt, anddocs/types/index.d.tscarry their own independent phrasing and are untouched.Related Issues
No.
Questions
No.
Other
No.
Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
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/pareto-type1, majority patterns were computed at a 75% conformance threshold, and two independent Opus validation agents (semantic-review and cross-reference) confirmed the finding was high-signal mechanical drift with no test or downstream contract depending on the exact strings before any file was edited. Both edits are pure JSDoc@modulesummary rephrasings; no source, tests, or behavior changed.Generated by Claude Code