docs: fix descriptions - #13696
Merged
Merged
Conversation
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`
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
approved these changes
Jul 27, 2026
random and stats packages
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
Propagating fixes merged to
developbetween 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
kas the scale parameter andlambdaas the shape parameter, inverted from the canonical parameterization inrandom/base/weibullandstats/base/dists/weibull. Corrects@paramJSDoc,docs/repl.txt, README prose, andtape()test descriptions in@stdlib/random/base/weibull@stdlib/random/iter/weibull@stdlib/random/streams/weibull@stdlib/random/strided/weibull@stdlib/random/array/weibullTypeScript declarations are out of scope (already covered by #12571; namespace declaration files are generated) and the swapped runtime
TypeErrorstrings inrandom/base/weibull/lib/validate.jsare left for a separatefix:-typed change, as they are runtime-observable strings catalogued in the error database.Capitalized "Rate parameter." for invgamma
betaCommit 8df3c50 corrected the lowercase
rate parameter→scale parameterfor invgamma'sbeta, but the capitalizedRate parameter.sentence-start variant survived in eight sites.betais a scale parameter under the inverse gamma parameterization; the rate parameterization belongs to the gamma distribution, where the identical string ingamma/ctor/README.mdis correct and untouched. Fixesdocs/repl.txtforinvgamma/{mean,mode,variance,skewness,stdev,kurtosis,entropy}and theinvgamma.betaproperty description ininvgamma/ctor/README.md.Consistent
@paramseparator formattingCollapsed the two remaining malformed
@paramseparators in the tree — a doubled dash in_tools/remark/plugins/remark-svg-equations/lib/transformer.jsand a doubled space inml/incr/sgd-regression/lib/validate.js— to the standardname - descriptionform, completing the cleanup started in 8df3c50.Related Issues
No.
Questions
No.
Other
Validation. Candidate sites were enumerated via pattern search over the namespaces touched by the source commit's defect classes (all
random/*/weibull*packages, allstats/base/dists/invgammasubpackages, and a repo-wide sweep for malformed@paramseparators). Every site was independently verified by two validation passes (defect present, parameter attachment confirmed against surrounding context, canonical parameterization confirmed againstrandom/base/weibull's implementationlambda * 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.tsfiles are generated), the runtimeTypeErrormessages inrandom/base/weibull/lib/validate.js(flaggedneeds-human: runtime-observable strings under adocs:-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
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was generated by an automated fix-propagation routine (Claude Code): it reviews commits merged to
developin 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