Skip to content

docs: propagate recent doc fixes across stats/base/dists/* and */base/ndarray/*#11815

Merged
kgryte merged 5 commits intodevelopfrom
philipp/fix-propagation-2026-04-27
Apr 27, 2026
Merged

docs: propagate recent doc fixes across stats/base/dists/* and */base/ndarray/*#11815
kgryte merged 5 commits intodevelopfrom
philipp/fix-propagation-2026-04-27

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Propagating fixes merged to develop between 2026-04-26 15:09 PT and 2026-04-27 01:56 ET to sibling packages.

Description

This pull request:

  • Propagates equation-label and SVG filename fixes from 31b9282 across nine packages in stats/base/dists/*, stripping doubled distribution-name prefixes (e.g., eq:chi_chi_cdfeq:chi_cdf, equation_weibull_weibull_pdf.svgequation_weibull_pdf.svg) from <equation> labels, data-equation attributes, 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}}.
  • Propagates the wording fix from 6ba8e82 across blas/base/ndarray/* and stats/base/ndarray/*, prepending the missing article a to 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:

  • Pattern search scope for 31b9282: stats/base/dists/**/README.md for eq:<dist>_<dist>_* doubled-prefix labels and matching equation_*.svg references.
  • Pattern search scope for 6ba8e82: blas/base/ndarray/** and stats/base/ndarray/** for - first/second one-dimensional input ndarray. bullets without a leading article, across *.md, *.txt, *.d.ts, and *.js.
  • Two independent validation passes confirmed every site; an adaptation pass produced the per-site label rewrites for the equation-label fix; a style-consistency pass approved both patterns.

Deliberately excluded:

  • Suffix mismatches in the */logpdf READMEs (e.g., eq:cauchy_pdf retained inside cauchy/logpdf because 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.
  • Two chore: fix JavaScript lint errors commits — single-file lint cleanups specific to one call site each, no generalizable signature.
  • docs: fix missing type (Array<integer>Array<integer>|integer in blas/ext/linspace/docs/repl.txt) — verified the six sibling ndarray/**/docs/repl.txt candidates strictly require an array (no scalar branch in lib/main.js); the existing docs are correct.
  • docs: add missing JSDoc example sections in _tools/pkgs packages — sibling packages already carry one @example block; adding a second would be enhancement, not the source defect (which was zero examples).

Checklist

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 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

claude added 2 commits April 27, 2026 13:43
…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).
@stdlib-bot
Copy link
Copy Markdown
Contributor

stdlib-bot commented Apr 27, 2026

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/beta/mgf $\color{green}409/409$
$\color{green}+0.00%$
$\color{green}24/24$
$\color{green}+0.00%$
$\color{green}5/5$
$\color{green}+0.00%$
$\color{green}409/409$
$\color{green}+0.00%$
stats/base/dists/cauchy/logpdf $\color{green}293/293$
$\color{green}+0.00%$
$\color{green}19/19$
$\color{green}+0.00%$
$\color{green}4/4$
$\color{green}+0.00%$
$\color{green}293/293$
$\color{green}+0.00%$
stats/base/dists/cauchy/pdf $\color{green}293/293$
$\color{green}+0.00%$
$\color{green}19/19$
$\color{green}+0.00%$
$\color{green}4/4$
$\color{green}+0.00%$
$\color{green}293/293$
$\color{green}+0.00%$
stats/base/dists/cauchy/quantile $\color{green}306/306$
$\color{green}+0.00%$
$\color{green}23/23$
$\color{green}+0.00%$
$\color{green}4/4$
$\color{green}+0.00%$
$\color{green}306/306$
$\color{green}+0.00%$
stats/base/dists/chi/quantile $\color{green}198/198$
$\color{green}+0.00%$
$\color{green}6/6$
$\color{green}+0.00%$
$\color{green}3/3$
$\color{green}+0.00%$
$\color{green}198/198$
$\color{green}+0.00%$
stats/base/dists/normal/logpdf $\color{green}312/312$
$\color{green}+0.00%$
$\color{green}23/23$
$\color{green}+0.00%$
$\color{green}4/4$
$\color{green}+0.00%$
$\color{green}312/312$
$\color{green}+0.00%$
stats/base/dists/normal/pdf $\color{green}316/316$
$\color{green}+0.00%$
$\color{green}25/25$
$\color{green}+0.00%$
$\color{green}4/4$
$\color{green}+0.00%$
$\color{green}316/316$
$\color{green}+0.00%$
stats/base/dists/weibull/logpdf $\color{green}308/308$
$\color{green}+0.00%$
$\color{green}35/35$
$\color{green}+0.00%$
$\color{green}4/4$
$\color{green}+0.00%$
$\color{green}308/308$
$\color{green}+0.00%$
stats/base/dists/weibull/pdf $\color{green}310/310$
$\color{green}+0.00%$
$\color{green}36/36$
$\color{green}+0.00%$
$\color{green}4/4$
$\color{green}+0.00%$
$\color{green}310/310$
$\color{green}+0.00%$

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.
@Planeshifter Planeshifter marked this pull request as ready for review April 27, 2026 14:36
@Planeshifter Planeshifter requested review from a team and kgryte April 27, 2026 14:36
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Apr 27, 2026

- first one-dimensional input ndarray.
- second one-dimensional input ndarray.
- a first one-dimensional input ndarray.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Effectively "first" and "second" in these descriptions should be considered a replacement for "a" or "an".

Reverts the article-prepend change to `blas/base/ndarray/{ddot,dswap,gdot,sdot}` from c997652 per @kgryte review on #11815: "It doesn't make sense to have the article 'a' before 'first' and 'second' in these lists. It just sounds awkward." The `stats/base/ndarray/*` changes remain.
@stdlib-bot stdlib-bot added the Statistics Issue or pull request related to statistical functionality. label Apr 27, 2026
*
* - first one-dimensional input ndarray.
* - second one-dimensional input ndarray.
* - a first one-dimensional input ndarray.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 kgryte removed the Needs Review A pull request which needs code review. label Apr 27, 2026
@kgryte kgryte merged commit 6a4d961 into develop Apr 27, 2026
14 checks passed
@kgryte kgryte deleted the philipp/fix-propagation-2026-04-27 branch April 27, 2026 23:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Statistics Issue or pull request related to statistical functionality.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants