docs: update descriptions and comments#13451
Merged
Merged
Conversation
Propagates fix from b59aade ("docs: update descriptions") to sibling packages that still spelled the distribution name as one word. Rewrites the human-readable descriptor to "beta prime" in JSDoc, source comments, a test description, and one README namespace-toc link label. Code identifiers, module paths, and link-def keys are unchanged.
Propagates fix from afc9d5b ("docs: clean-up") to every package.json whose "description" field wrapped `NaN` in backticks. JSON strings do not render markdown, so the backticks display literally on the npm registry and in stdlib tooling. Removes them across sibling `nan*` and `*nan*` packages under `stats/`, `blas/ext/base/`, and their `ndarray`, `array`, `wasm`, and `incr` variants.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
approved these changes
Jul 13, 2026
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-12 13:48 UTC and 2026-07-13 09:12 UTC to sibling packages that carried the same defect.docs: update descriptions(b59aade)Source commit rewrote the human-readable descriptor "betaprime" as two words in
random/betaprime. Sibling packages that reference the beta prime distribution as prose were still spelling it as one word. Applies the same rewrite to JSDoc, C/JS source comments, a test description string, and one namespace-toc link label. Code identifiers, module paths, and the[betaprime-distribution]link-def key are unchanged.Target sites:
lib/node_modules/@stdlib/random/docs/types/index.d.tslib/node_modules/@stdlib/stats/base/dists/betaprime/test/test.jslib/node_modules/@stdlib/stats/base/dists/betaprime/logpdf/lib/factory.jslib/node_modules/@stdlib/stats/base/dists/betaprime/logpdf/lib/main.jslib/node_modules/@stdlib/stats/base/dists/betaprime/logpdf/src/main.clib/node_modules/@stdlib/stats/base/dists/betaprime/README.mddocs: clean-up(afc9d5b)Source commit removed markdown backticks around
NaNin threestats/incr/nan*package.json descriptions. JSON strings are surfaced verbatim on the npm registry and in stdlib REPL/tooling, so the backticks render literally. Extends the same removal to every remainingpackage.jsonunderlib/node_modules/@stdlib/whosedescriptionfield wrapsNaNin backticks. All 81 sites share the identical mechanical transformation.Target sites: 81
package.jsonfiles acrossstats/,stats/base/ndarray/,stats/array/,stats/incr/,blas/ext/base/,blas/ext/base/ndarray/, andblas/ext/base/wasm/. Full list is enumerated in the local propagation report.Related Issues
No.
Questions
No.
Other
Validation
For each source pattern, sibling packages were located via
rgscoped to the relevant subdirectories:"betaprime distribution"text and[betaprime][…]markdown link-labels outside the already-fixedrandom/betaprime/package;"description": .*`NaN`.*in everypackage.jsonunderlib/node_modules/@stdlib/.needs-humanverdicts across all 87 sites.logpdfcomments tobeta prime distribution(all lowercase) to match the file's own JSDoc convention on nearby lines, rather than the initialBeta prime distributionproposal.random/base/betaprime/README.md,random/array/betaprime/README.md, andrandom/strided/betaprime/README.mdare inside<!-- Do not manually edit this section, as it is automatically populated. -->blocks — the fix belongs in the generator and will regenerate on the next docs run. Also excluded: 200 additionalpackage.jsondescriptionfields that wrap identifiers other thanNaNin backticks — outside the source commit's pattern.Search commit reference
Source commits fall within the range
b59aade7c8f532f93f105ef75c0b165b18dc759a..89717ddc35cff32083cafe5ddf62a6be82d1f7a6ondevelop.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by an automated propagation routine that scans commits merged to
developin the preceding 24 hours, specifies each fix's search signature, enumerates sibling packages likely to carry the same defect, runs a four-agent validation (two independent verifiers, one adaptation, one style-consistency check), and applies only the patches all four agents approved. Each commit corresponds to one source fix pattern and is limited to the corresponding validated propagation sites.@stdlib-js/reviewers
Generated by Claude Code