docs: update descriptions#13438
Merged
Merged
Conversation
Normalizes the multi-word distribution name from "betaprime distribution" to "beta prime distribution" across the package's `README.md` intro/notes blockquote and method descriptions, `lib/main.js`, `lib/index.js`, and `lib/factory.js` JSDoc description lines, and the `package.json` description field. Aligns with the spelling used by every other distribution package in `@stdlib/random/*` (33 of 33 use spaced/hyphenated multi-word names, e.g. "negative binomial distribution", "chi-square distribution", "discrete uniform distribution") and by all sibling `betaprime` packages under `@stdlib/random/base`, `@stdlib/random/array`, `@stdlib/random/strided`, and `@stdlib/stats/base/dists`. The link anchor `@stdlib/random/base/betaprime` and every code identifier remain unchanged; only the human-readable distribution name in prose is affected. docs/repl.txt and docs/types/index.d.ts are excluded per the drift-audit convention (auto-populated / generator-owned).
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
reviewed
Jul 12, 2026
kgryte
left a comment
Member
There was a problem hiding this comment.
This needs to be fixed in the scaffold meta data, as well. Otherwise, if the scaffold is run again, these changes will be overwritten.
…d data Aligns the scaffold source with the leaf-package fix in the previous commit so that a scaffold re-run will not overwrite the "beta prime" prose. Rewrites `from_desc`, `readme_from_desc`, `repl_text_main_desc`, `repl_text_assign_desc`, and `repl_text_factory_desc`. The `keywords` field is unchanged — `betaprime` there is the package identifier used for keyword search, not the distribution's prose name.
kgryte
approved these changes
Jul 12, 2026
@stdlib/random/betaprime
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 distribution name "betaprime" (concatenated) to the canonical "beta prime" (two words) in
@stdlib/random/betaprime's prose and metadata. Every other distribution package in@stdlib/random/*already spells its multi-word distribution name with proper spacing/hyphenation (e.g., "chi-square distribution", "negative binomial distribution", "discrete uniform distribution", "inverse gamma distribution", "Student's t-distribution"), and every siblingbetaprimepackage under@stdlib/random/base,@stdlib/random/array,@stdlib/random/strided, and@stdlib/stats/base/distsalready uses "beta prime" in itspackage.jsondescription;@stdlib/random/betaprimewas the lone holdout.Namespace summary
@stdlib/random/{arcsine, array, base, bernoulli, beta, betaprime, binomial, cauchy, chi, chisquare, cosine, discrete-uniform, erlang, exponential, f, frechet, gamma, geometric, gumbel, hypergeometric, invgamma, iter, kumaraswamy, laplace, levy, logistic, lognormal, negative-binomial, normal, pareto-type1, poisson, rayleigh, sample, shuffle, streams, strided, t, tools, triangular, uniform, weibull}).array,base,iter,streams,strided,tools— and 2 non-PRNG helpers —sample,shuffle).package.jsonshape (18 keys, identical across 33/33 distributions), README section list (Usage→Notes→Examples→See Also, identical across 33/33), JSDoc@throwslist inmain.jsandfactory.js(identical across 33/33),@examplecounts (2 permain.js, 2 perfactory.js, 4 perindex.js), keyword base set (19 keywords present in 33/33), output-policy taxonomy (continuous →real_floating_point_and_generic, discrete →real_and_generic), factory arity taxonomy (unary/binary/ternary matches distribution parameter count), examples file line count (53 in 33/33), and prose distribution-name spelling (spaced/hyphenated in 32/33 distributions;betaprimeis the sole outlier).lib/main.js/lib/factory.js/benchmark files (~80% present; the 6 umbrella packages legitimately re-export sub-namespaces,sample/shuffleuse a different benchmark shape), copyright year (staleness, not drift).@stdlib/random/betaprimeFix
betaprime→beta primein prose acrosslib/main.js,lib/index.js,lib/factory.js,package.json, andREADME.md(four JSDoc description lines, the manifestdescriptionfield, and the intro blockquote plus three.method()blurbs). Every other@stdlib/random/*multi-word distribution name is spaced or hyphenated —chi-square,negative binomial,discrete uniform— and every siblingbetaprimepackage acrossbase,array,strided, andstats/base/distsalready says "beta prime"; this package was the lone holdout. Link anchors (@stdlib/random/base/betaprime) are untouched, only display text and prose;docs/repl.txtanddocs/types/index.d.tsare excluded per the standard drift-audit convention.Related Issues
None.
Questions
None.
Other
Validation
lib/node_modules/@stdlib/random/and captured file trees,package.jsonkey sets andkeywordsarrays, README##/###heading sequences, and test/benchmark/example file naming. File presence is uniform across the 33-package distribution subset;package.jsontop-level key set is identical (18 keys); the 19-keyword base set (stdlib,stdmath,mathematics,math,statistics,stats,prng,rng,pseudorandom,random,rand,generator,seed,seedable,ndarray,multidimensional,array,vector,matrix) is present in 33/33; README heading sequence is identical.lib/main.js,lib/index.js, andlib/factory.jsacross a representative subset covering unary/binary/ternary arity and continuous/discrete support (arcsine, beta, betaprime, hypergeometric, frechet, normal, negative-binomial, pareto-type1, lognormal, discrete-uniform).@throwslists inmain.jsandfactory.js, output-policy naming,exportsend-of-file comments, and dtypes-module requires are all identical across the sample; the only substantive semantic outlier wasbetaprime's use of "betaprime distribution" as the distribution name in prose, contradicting the canonical two-word form used by every other package in the sample.confirmed-driftfor thebetaprimeprose-normalization candidate. Cross-reference read every test file (test.js,test.main.js,test.factory.js,test.assign.js) andexamples/index.jsunder@stdlib/random/betaprimeand confirmed nothing string-matches the current phrasing; type-only checks indocs/types/test.tsdo not depend on description text.stdlib-js/stdlibtargets this fix; the open drift/propagation PR chore: propagate recentdevelopfixes to sibling packages (2026-07-10) #13410 touchesstats/base/dists/betaprime/{pdf,logpdf}(a different pattern in a different subtree) and is unrelated. No PR merged in the last 14 days applies this fix.Deliberately excluded
@stdlib/random/{array, base, iter, streams, strided, tools}) legitimately re-export sub-namespaces and have nolib/main.js/lib/factory.jsby design; the missing files are not drift.@stdlib/random/{sample, shuffle}implement collection-sampling primitives with a single-filebenchmark/benchmark.jsandtest/test.jsshape rather than the ndarray-multi-shape benchmark/test pattern used by the distributions; the shape difference reflects a genuine semantic difference (they do not produce ndarrays and take noshapeargument).docs/repl.txtanddocs/types/index.d.tsunder@stdlib/random/betaprimestill contain "betaprime distribution" in eight further places. Excluded per the drift-audit convention that treats these as generator-owned; leaving them for a scaffold-source sync (see below).lib/node_modules/@stdlib/random/scripts/scaffolds/binary/scripts/data/betaprime.jsoncontains the same "betaprime distribution" phrasing in itsfrom_desc,readme_from_desc, and threerepl_text_*_descfields. Fixing the scaffold source is out of scope for a per-package drift correction — regenerating from a corrected scaffold and re-syncingdocs/repl.txt,docs/types/index.d.ts, and the sibling packages' auto-populated## See Alsoentries is a separate, larger sweep. Logged for the next run.@stdlib/random/hypergeometric(2026 vs 2025 elsewhere) is staleness from a recent touch, not drift.Checklist
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 cross-package API drift audit of
@stdlib/random. The target namespace was picked at random from the 122 stdlib namespaces containing ≥8 direct package children. Structural features were extracted from every member; semantic features were extracted via an LLM agent from a distribution-arity-diverse subset; each proposed correction was independently confirmed asconfirmed-driftby three parallel reviewer agents (Opus semantic-review, Opus cross-reference, Sonnet structural-review) before the patch was applied in the primary worktree. A maintainer should audit and promote out of draft.Generated by Claude Code