docs: fix parameter descriptions and update spacing - #13671
Merged
Conversation
Propagates fixes from b06219c ("chore: clean-up") to sibling packages carrying the same defects: - relabel the inverse gamma `beta` from "rate parameter" to "scale parameter" across `stats/base/dists/invgamma` documentation, test descriptions, and fixture-runner docstrings - expand the one-line doxygen descriptions in the `invgamma/{pdf,cdf}` headers to match the wording already present in each package's `src/main.c` - normalize index-bracket and call-paren spacing in `stats/base/dists/{anglit,invgamma}` test files
Propagates fix from 01a20c0 ("style: remove extraneous whitespace") to
the one remaining JSDoc `@param` line with a doubled space around the
hyphen separator.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
marked this pull request as ready for review
July 26, 2026 23:33
kgryte
approved these changes
Jul 26, 2026
develop fixes to sibling packages (2026-07-26)
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
> What is the purpose of this pull request?
Propagating fixes merged to
developbetween 2026-07-26 00:12 PDT (0239983) and 2026-07-26 03:02 PDT (a7865fd) to sibling packages carrying the same defect.Pattern: rate parameter → scale parameter (
invgamma)Commit b06219c (#13653) corrected a test description in
invgamma/quantile, relabelingbetafrom "rate parameter" to "scale parameter" — forX ~ Gamma(α, β),1/X ~ InvGamma(α, β)withβa scale, not rate, consistent with stdlib's moment formulas (e.g.,mean = β/(α−1)) and the JuliaDistributions.jlfixture generators (InverseGamma(alpha, beta), θ = scale). This propagates the fix to the 101 remaining "rate parameter" occurrences across 64 files understats/base/dists/invgamma/**— JSDoc/TSDoc and C doxygen@paramblocks, README prose and C-API bullets,docs/repl.txt, test descriptions, example comments, and Julia fixture-runner docstrings — several files had both correct and stale labels side by side. Variable names (largeRate) and fixture filenames (large_rate.json) are left as-is, matching the source commit.b06219c(chore: clean-up)stats/base/dists/invgamma/{cdf,ctor,entropy,kurtosis,logpdf,mean,mode,pdf,quantile,skewness,stdev,variance}stats/base/dists/invgamma/docs/types/index.d.ts(namespace declarations)Pattern: doxygen one-liner expansion (
invgammasiblings)PR #13653 (
b06219c7a) expanded the doxygen one-liner inquantile's header andsrc/main.cfrom "Evaluates the quantile function for an inverse gamma distribution." to namealpha,beta, and the evaluation argument explicitly;logpdfalready carried the expanded form in its header.pdfandcdfstill had the short form in their headers while their ownsrc/main.calready had the expanded sentence — this propagates that same expansion intopdf/include/.../pdf.handcdf/include/.../cdf.h, copied byte-for-byte from each package'ssrc/main.c. Headers and implementation now agree across all fourinvgammapackages.b06219c(chore: clean-up)stats/base/dists/invgamma/pdf(header only)stats/base/dists/invgamma/cdf(header only)Pattern: unspaced index brackets and paren spacing in dists test suites
Follows up on b06219c (#13653) by completing the bracket/paren spacing sweep across the remaining
stats/base/dists/anglitandstats/base/dists/invgammatest files: 304 lines across 46 files normalizex[i]→x[ i ]style index accesses (expected,alpha,beta,sigma,mu,p,values), plus one unspaced outer-parent.strictEqualcall inanglit/cdf/test/test.factory.js. Purely mechanical spacing changes to match stdlib style; no logic, variable names, or test messages touched.b06219c(chore: clean-up)stats/base/dists/anglit/{cdf,entropy,mean,median,mode,quantile,skewness,stdev,variance}test filesstats/base/dists/invgamma/{cdf,ctor,entropy,kurtosis,logpdf,mean,mode,pdf,quantile,skewness,stdev,variance}test filesPattern:
@paramwhitespace propagation from #1365401a20c0 (#13654) removed doubled spaces around the
-separator in@paramtags but only coveredrandom/iter/*andstats/base/dists/binomial/quantile. A repo-wide sweep for the same defect turned up one more site:blas/base/gscal/lib/main.js, wherestride - stride lengthcollapses to a single space. The other four hits are out of scope —random/strided/docs/types/index.d.tsis generated,random/strided/weibull/docs/types/index.d.tsandml/incr/sgd-regression/lib/validate.jsare superseded by open PRs #12571 and #13641, and the_toolstransformer hit is a doubled-hyphen defect requiring a different fix.01a20c0(style: remove extraneous whitespace)blas/base/gscalRelated Issues
> Does this pull request have any related issues?
No.
Questions
> Any questions for reviewers of this pull request?
No.
Other
> Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.
Validation
rg 'rate parameter'overstats/base/dists/invgamma/**(101 hits, 64 files; zero hits underrandom/**invgamma packages, which already say "scale");rgfor short-form doxygen descriptions over invgamma headers and sources;rg '\[[a-z0-9]+\]'overstats/base/dists/{anglit,invgamma}/**/test/*.js(304 hits, 46 files;anglit/pdfandinvgamma/quantile/test/test.native.jscorrectly absent — already fixed by the source commit); repo-wide sweep for doubled-space@paramseparators (5 hits, 4 excluded).betais a scale parameter (pdf form, scale-linear moment formulas,Distributions.jlparameterization) and verifying the namespacedocs/types/index.d.tsis hand-maintained, not generated. An adaptation pass produced byte-exact patches (confirming C doxygen@paramcolumn alignment is preserved and no markdown link labels or`[in]`code spans are touched), and a style-consistency pass verified the post-fix text against already-correct siblings (rayleigh,fdist test descriptions;random/base/invgammadocs).Deliberately excluded:
@parampattern above).test:ULP-migration commits (d98aba7,4588717) — tracked campaign work ([RFC]: Migratemath/base/specialpackages from relative tolerance testing to ULP difference testing (tracking issue) #11352), not propagatable defect fixes.docs: update related packages sections(0239983) — auto-generated churn.b06219c: "modified huber" → "modified Huber" capitalization (only intentional lowercase npm keywords remain) and README NaN per-argument example coverage (allml/base/losssiblings already correct).largeRatevariables andlarge_rate.jsonfixture filenames (renaming would cascade into fixture regeneration; matches source-commit precedent).invgamma/entropy/README.md, doubled space ininvgamma/pdf/README.mdlink prose, missing C++ name-mangling comment incdf.h, and the_toolsdoubled-hyphen@paramdefect — logged for a future maintenance pass.Checklist
> Please ensure the following tasks are completed before submitting this pull request.
AI Assistance
> When authoring the changes proposed in this PR, did you use any kind of AI assistance?
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code on behalf of @Planeshifter as an automated propagation of fixes merged to
developover the prior 24 hours. Candidate source commits were filtered for generalizable patterns, sibling sites located via grep-able pattern signatures, and each proposed patch independently validated by parallel reviewer agents (two Opus validation passes, an adaptation pass, and a style-consistency pass) before commits were applied. A maintainer should audit and promote out of draft.Generated by Claude Code