Skip to content

docs: fix descriptions - #13696

Merged
kgryte merged 1 commit into
developfrom
philipp/fix-propagation-2026-07-27
Jul 27, 2026
Merged

docs: fix descriptions#13696
kgryte merged 1 commit into
developfrom
philipp/fix-propagation-2026-07-27

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

Propagating fixes merged to develop between 2026-07-26 and 2026-07-27 to sibling packages. Source commit: 8df3c50 ("docs: fix parameter descriptions and update spacing").

Swapped shape/scale parameter descriptions in Weibull docs

Documentation across the Weibull PRNG packages described k as the scale parameter and lambda as the shape parameter, inverted from the canonical parameterization in random/base/weibull and stats/base/dists/weibull. Corrects @param JSDoc, docs/repl.txt, README prose, and tape() test descriptions in

  • @stdlib/random/base/weibull
  • @stdlib/random/iter/weibull
  • @stdlib/random/streams/weibull
  • @stdlib/random/strided/weibull
  • @stdlib/random/array/weibull

TypeScript declarations are out of scope (already covered by #12571; namespace declaration files are generated) and the swapped runtime TypeError strings in random/base/weibull/lib/validate.js are left for a separate fix:-typed change, as they are runtime-observable strings catalogued in the error database.

Capitalized "Rate parameter." for invgamma beta

Commit 8df3c50 corrected the lowercase rate parameterscale parameter for invgamma's beta, but the capitalized Rate parameter. sentence-start variant survived in eight sites. beta is a scale parameter under the inverse gamma parameterization; the rate parameterization belongs to the gamma distribution, where the identical string in gamma/ctor/README.md is correct and untouched. Fixes docs/repl.txt for invgamma/{mean,mode,variance,skewness,stdev,kurtosis,entropy} and the invgamma.beta property description in invgamma/ctor/README.md.

Consistent @param separator formatting

Collapsed the two remaining malformed @param separators in the tree — a doubled dash in _tools/remark/plugins/remark-svg-equations/lib/transformer.js and a doubled space in ml/incr/sgd-regression/lib/validate.js — to the standard name - description form, completing the cleanup started in 8df3c50.

Related 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. Candidate sites were enumerated via pattern search over the namespaces touched by the source commit's defect classes (all random/*/weibull* packages, all stats/base/dists/invgamma subpackages, and a repo-wide sweep for malformed @param separators). Every site was independently verified by two validation passes (defect present, parameter attachment confirmed against surrounding context, canonical parameterization confirmed against random/base/weibull's implementation lambda * pow( -ln(1-u), 1/k ) and distribution moments), an adaptation pass (exact per-site patches, self-contained within each target file), and a style-consistency pass against sibling packages. Deliberately excluded: TypeScript declaration files (overlap with #12571; namespace .d.ts files are generated), the runtime TypeError messages in random/base/weibull/lib/validate.js (flagged needs-human: runtime-observable strings under a docs:-typed change), generated REPL data artifacts (repl/help/data/*, repl/info/data/*), and sites where "rate"/"shape" terminology is correct for the distribution in question (Erlang, Wald, gamma).

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?

  • 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 generated by an automated fix-propagation routine (Claude Code): it reviews commits merged to develop in the last 24 hours for generalizable fixes, locates sibling packages with the same defect, and applies the equivalent fix at sites confirmed by two independent validation agents plus adaptation and style-consistency passes. All 54 changed lines were verified against file content before and after application.


@stdlib-js/reviewers


Generated by Claude Code

Propagates fix from 8df3c50 ("docs: fix parameter descriptions and
update spacing") to sibling packages with the same defects:

-   swap Weibull `k` (shape) and `lambda` (scale) parameter role
    descriptions, which were reversed in JSDoc, REPL help, README
    prose, and test descriptions across `random/base/weibull`,
    `random/iter/weibull`, `random/streams/weibull`,
    `random/strided/weibull`, and `random/array/weibull`
-   replace remaining capitalized `Rate parameter` descriptions for
    `beta` in `stats/base/dists/invgamma` REPL help and README docs
    with `Scale parameter`
-   remove extraneous whitespace in `@param` descriptions in
    `ml/incr/sgd-regression` and
    `_tools/remark/plugins/remark-svg-equations`
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
ml/incr/sgd-regression $\\color{green}917/917$
$\\color{green}+100.00\\%$
$\\color{green}103/103$
$\\color{green}+100.00\\%$
$\\color{green}18/18$
$\\color{green}+100.00\\%$
$\\color{green}917/917$
$\\color{green}+100.00\\%$
random/array/weibull $\\color{green}212/212$
$\\color{green}+100.00\\%$
$\\color{green}3/3$
$\\color{green}+100.00\\%$
$\\color{green}0/0$
$\\color{green}+100.00\\%$
$\\color{green}212/212$
$\\color{green}+100.00\\%$
random/base/weibull $\\color{green}500/500$
$\\color{green}+100.00\\%$
$\\color{green}55/55$
$\\color{green}+100.00\\%$
$\\color{green}12/12$
$\\color{green}+100.00\\%$
$\\color{green}500/500$
$\\color{green}+100.00\\%$
random/iter/weibull $\\color{green}300/300$
$\\color{green}+100.00\\%$
$\\color{green}35/35$
$\\color{green}+100.00\\%$
$\\color{green}10/10$
$\\color{green}+100.00\\%$
$\\color{green}300/300$
$\\color{green}+100.00\\%$
random/streams/weibull $\\color{green}819/819$
$\\color{green}+100.00\\%$
$\\color{green}95/95$
$\\color{green}+100.00\\%$
$\\color{green}15/15$
$\\color{green}+100.00\\%$
$\\color{green}819/819$
$\\color{green}+100.00\\%$
random/strided/weibull $\\color{green}295/295$
$\\color{green}+100.00\\%$
$\\color{green}19/19$
$\\color{green}+100.00\\%$
$\\color{green}3/3$
$\\color{green}+100.00\\%$
$\\color{green}295/295$
$\\color{green}+100.00\\%$
stats/base/dists/invgamma/ctor $\\color{green}408/408$
$\\color{green}+100.00\\%$
$\\color{green}31/31$
$\\color{green}+100.00\\%$
$\\color{green}16/16$
$\\color{green}+100.00\\%$
$\\color{green}408/408$
$\\color{green}+100.00\\%$
stats/base/dists/invgamma/entropy $\\color{green}201/201$
$\\color{green}+100.00\\%$
$\\color{green}10/10$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}201/201$
$\\color{green}+100.00\\%$
stats/base/dists/invgamma/kurtosis $\\color{green}203/203$
$\\color{green}+100.00\\%$
$\\color{green}10/10$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}203/203$
$\\color{green}+100.00\\%$
stats/base/dists/invgamma/mean $\\color{green}192/192$
$\\color{green}+100.00\\%$
$\\color{green}10/10$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}192/192$
$\\color{green}+100.00\\%$
stats/base/dists/invgamma/mode $\\color{green}195/195$
$\\color{green}+100.00\\%$
$\\color{green}10/10$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}195/195$
$\\color{green}+100.00\\%$
stats/base/dists/invgamma/skewness $\\color{green}193/193$
$\\color{green}+100.00\\%$
$\\color{green}10/10$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}193/193$
$\\color{green}+100.00\\%$
stats/base/dists/invgamma/stdev $\\color{green}196/196$
$\\color{green}+100.00\\%$
$\\color{green}10/10$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}196/196$
$\\color{green}+100.00\\%$
stats/base/dists/invgamma/variance $\\color{green}196/196$
$\\color{green}+100.00\\%$
$\\color{green}10/10$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}196/196$
$\\color{green}+100.00\\%$

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

@kgryte
kgryte marked this pull request as ready for review July 27, 2026 21:53
@kgryte
kgryte requested a review from a team July 27, 2026 21:53
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jul 27, 2026
@kgryte kgryte changed the title docs: fix parameter descriptions across random and stats packages docs: fix descriptions Jul 27, 2026
@kgryte
kgryte merged commit a103b47 into develop Jul 27, 2026
37 checks passed
@kgryte
kgryte deleted the philipp/fix-propagation-2026-07-27 branch July 27, 2026 21:54
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Jul 27, 2026
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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants