docs: correct parameter prose in stats/base/dists/gumbel/mgf doc comments#12007
Open
Planeshifter wants to merge 1 commit intodevelopfrom
Open
docs: correct parameter prose in stats/base/dists/gumbel/mgf doc comments#12007Planeshifter wants to merge 1 commit intodevelopfrom
stats/base/dists/gumbel/mgf doc comments#12007Planeshifter wants to merge 1 commit intodevelopfrom
Conversation
… convention Description prose for `mgf` referenced the scale parameter as `b` (rather than `beta`, which is the actual variable name and what 13/13 sibling packages and `mgf`'s own README/repl.txt use), labeled `mu` as `mean` (rather than `location parameter`, used by 13/13 siblings), and the `declare var mgf` JSDoc opened with "Gamma distribution moment-generating function" (5/5 factory-style siblings open with "Gumbel distribution ..."). Aligned all six affected files to the namespace convention. No behavior, signatures, exports, or test expectations change; the actual function parameter remains `beta` at every site.
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
Documentation prose in
@stdlib/stats/base/dists/gumbel/mgfreferenced the scale parameter asband labeled the location parametermuas "mean", and the package's TypeScript declaration opened thedeclare varJSDoc block with "Gamma distribution" — copy-paste artifacts inconsistent with bothmgf's own README/repl.txt and 13/13 sibling packages in the namespace. Six files were normalized to the namespace convention; no behavior, signatures, exports, or test expectations change.Namespace summary
stats/base/dists/gumbel/)package.jsonshape,manifest.jsonpresence, README sections (set + order), test/benchmark/examples filenames, public signature, validation prologue, return kind, error construction, JSDoc shape, doc-comment prose, dependenciesctor(no native bindings),mgfandskewness(notest/fixtures/julia/) — see Validationstats/base/dists/gumbel/mgfThe function-summary line in
lib/main.js,lib/factory.js,lib/native.js,docs/types/index.d.ts,include/stdlib/stats/base/dists/gumbel/mgf.h, andsrc/main.creferenced the scale parameter as`b`(13/13 sibling packages andmgf's own README/repl.txt use`beta`). The@param mudescription inlib/main.js,lib/factory.js, and three sites indocs/types/index.d.tswas "mean" rather than "location parameter" (13/13 siblings use "location parameter";muis not the mean of the Gumbel distribution —mu + beta·γ_Eis). Thedeclare var mgfJSDoc opened with "Gamma distribution moment-generating function (MGF)." (5/5 factory-style siblings open with "Gumbel distribution …"). Total: 13 sites, 6 files, +13 / −13 LOC.Validation
What was checked:
package.jsonshape, README headings, test/benchmark/examples file naming).mgf's doc-comment drift →confirmed-drift(parameter is namedbetain code;muis a location parameter, not the mean;Gamma distributionis a copy-paste artifact).mgf's tests, examples, factory, native bindings, namespace re-exports, and any consumer importing the package →safe-to-apply(no test, fixture, or downstream consumer references the existing wording).What was deliberately excluded:
ctor's missingbinding.gyp,manifest.json, native bindings, and## C APIsREADME section — inapplicable to a JavaScript constructor with property accessors.mgf's andskewness's missingtest/fixtures/julia/directory —mgf's tests already exercise analytically known values;skewnessfor Gumbel is a parameter-independent constant (Julia ground-truth fixtures would be mathematically meaningless).lib/factory.js/lib/index.jsonly present in the six factory-style packages — minority pattern, not drift.## NotesREADME section inlogcdf/logpdf— minority pattern reflecting genuine domain notes for those functions.Other
This PR is the output of a per-namespace cross-package drift-detection routine. The full per-feature majority/conformance/outlier breakdown and per-agent verdicts are recorded in the local report at
~/drift-reports/drift-stats-base-dists-gumbel-2026-05-09.md.Checklist
AI Assistance
How AI assistance was used:
Disclosure
This PR was authored by Claude Code running an automated cross-package drift-detection routine. The routine extracted structural and semantic features from every member of
stats/base/dists/gumbel/, computed per-feature majority patterns at a 75% threshold, and dispatched two independent Opus validation agents (semantic review, cross-reference safety check) against the surviving findings. The single advancing finding produced this 13-site, 6-file, behavior-preserving prose normalization.Generated by Claude Code