docs: propagate recent doc fixes across stats/base/dists/* and */base/ndarray/*#11815
Merged
docs: propagate recent doc fixes across stats/base/dists/* and */base/ndarray/*#11815
stats/base/dists/* and */base/ndarray/*#11815Conversation
…ase/dists/*` Propagates fix from 31b9282 ("docs: propagate equation-label / SVG copy-paste fixes across `stats/base/dists/*`") to nine sibling distribution measures whose READMEs still embed a doubled distribution prefix in the `<equation label="...">`, `data-equation="..."`, and `<img src="...equation_*.svg">` attributes (with the on-disk SVG renamed to match): beta/mgf, cauchy/{pdf,logpdf,quantile}, chi/quantile, normal/{pdf,logpdf}, weibull/{pdf,logpdf}.
… input ndarray` notes Propagates fix from 6ba8e82 ("docs: fix wording in dswap notes for `blas/base/ndarray`") to sibling packages whose JSDoc / repl.txt / README bullets describe ordered ndarray inputs without the leading article: `blas/base/ndarray/{ddot,dswap,gdot,sdot}` and `stats/base/ndarray/{covarmtk,dcovarmtk,scovarmtk,dztest2,sztest2,ztest2}` plus the aggregate `stats/base/ndarray/docs/types/index.d.ts` (six occurrences).
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
Reverts the article-prepend change to `stats/base/ndarray/{dztest2,sztest2,ztest2}/docs/repl.txt` from c997652. Touching these `repl.txt` files triggers `Lint Changed Files`, which surfaces pre-existing lint errors in each (`resolvable-aliases` for `@stdlib/stats/base/ztest/two-sample/results/{float64,float32}` and `@stdlib/array/struct-factory`, and `code-semicolons` violations) — out of scope here. The corresponding `lib/main.js` and `docs/types/index.d.ts` JSDoc fixes for these packages remain.
kgryte
reviewed
Apr 27, 2026
|
|
||
| - first one-dimensional input ndarray. | ||
| - second one-dimensional input ndarray. | ||
| - a first one-dimensional input ndarray. |
Member
There was a problem hiding this comment.
I reverted the changes to *dot. It doesn't make sense to have the article "a" before "first" and "second" in these lists. It just sounds awkward.
All changes to blas/base/ndarray in this PR should be reverted.
Member
There was a problem hiding this comment.
Effectively "first" and "second" in these descriptions should be considered a replacement for "a" or "an".
kgryte
reviewed
Apr 27, 2026
| * | ||
| * - first one-dimensional input ndarray. | ||
| * - second one-dimensional input ndarray. | ||
| * - a first one-dimensional input ndarray. |
Member
There was a problem hiding this comment.
Same thing. All changes to stats/base/ndarray should be reverted. No need to prefix the description with "a".
Reverts the article-prepend change to `stats/base/ndarray/{covarmtk,dcovarmtk,scovarmtk,dztest2,sztest2,ztest2}` and the aggregate `stats/base/ndarray/docs/types/index.d.ts` from c997652 per @kgryte review on #11815: "first" and "second" in these descriptions act as a replacement for "a"/"an", so prefixing the bullet with "a" is unnecessary.
kgryte
approved these changes
Apr 27, 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.
Propagating fixes merged to
developbetween 2026-04-26 15:09 PT and 2026-04-27 01:56 ET to sibling packages.Description
This pull request:
stats/base/dists/*, stripping doubled distribution-name prefixes (e.g.,eq:chi_chi_cdf→eq:chi_cdf,equation_weibull_weibull_pdf.svg→equation_weibull_pdf.svg) from<equation>labels,data-equationattributes, and<img src>URLs in affected READMEs. On-disk SVGs are renamed to match. Changes are mechanical; suffix corrections (where the embedded formula differs from the measure) are out of scope and left for a follow-on. Targets:stats/base/dists/{beta/mgf, cauchy/{pdf,logpdf,quantile}, chi/quantile, normal/{pdf,logpdf}, weibull/{pdf,logpdf}}.blas/base/ndarray/*andstats/base/ndarray/*, prepending the missing articleato bullets describing ordered ndarray inputs (e.g.,- first one-dimensional input ndarray.→- a first one-dimensional input ndarray.). Corrections span READMEs, repl.txt files, TypeScript declarations, and JSDoc in library entry points, touching 29 files and fixing 68 lines. Bullets already containing a grammatical article (the first/second) are left unchanged.Related Issues
No.
Questions
No.
Other
Validation:
stats/base/dists/**/README.mdforeq:<dist>_<dist>_*doubled-prefix labels and matchingequation_*.svgreferences.blas/base/ndarray/**andstats/base/ndarray/**for- first/second one-dimensional input ndarray.bullets without a leading article, across*.md,*.txt,*.d.ts, and*.js.Deliberately excluded:
*/logpdfREADMEs (e.g.,eq:cauchy_pdfretained insidecauchy/logpdfbecause the README intro embeds the PDF formula). Renaming the suffix is outside the source commit's pattern.bench:string-interpolation refactors merged in the same window — pattern is a sweep-style refactor already covering its own namespaces, not a propagatable defect.chore: fix JavaScript lint errorscommits — single-file lint cleanups specific to one call site each, no generalizable signature.docs: fix missing type(Array<integer>→Array<integer>|integerinblas/ext/linspace/docs/repl.txt) — verified the six siblingndarray/**/docs/repl.txtcandidates strictly require an array (no scalar branch inlib/main.js); the existing docs are correct.docs: add missing JSDoc example sections in _tools/pkgs packages— sibling packages already carry one@exampleblock; adding a second would be enhancement, not the source defect (which was zero examples).Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code as part of a fix-propagation routine. Each propagation site was independently validated by two opus-class agents, an adaptation agent produced per-site rewrites for the adaptive equation-label fix, and a style-consistency pass approved the result before commit.
@stdlib-js/reviewers
Generated by Claude Code