Skip to content

docs: propagate recent doc fixes to sibling ndarray, stats/base/ndarray, and types packages#11777

Open
Planeshifter wants to merge 3 commits intodevelopfrom
philipp/fix-propagation-2026-04-25
Open

docs: propagate recent doc fixes to sibling ndarray, stats/base/ndarray, and types packages#11777
Planeshifter wants to merge 3 commits intodevelopfrom
philipp/fix-propagation-2026-04-25

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

Propagating fixes merged to develop between 2026-04-24 15:07 PDT and 2026-04-24 17:40 PDT to sibling packages with the same defect.

3ca7c21 — drop redundant data-type qualifier in *-like test comments

Propagates the fix from 3ca7c21 — dropping the verbose "having a recognized/supported data type" qualifier from the first-argument $ExpectError block comment — to the top-level sibling packages, which also carried a grammar defect ("first argument is not an ndarray which has" instead of "first argument which is not an ndarray"). Both issues are corrected to the canonical form: // The compiler throws an error if the function is provided a first argument which is not an ndarray....

  • lib/node_modules/@stdlib/ndarray/empty-like/docs/types/test.ts
  • lib/node_modules/@stdlib/ndarray/zeros-like/docs/types/test.ts

5a06940 — fix BooleanArray @example annotation typo

Commit 5a06940 fixed a copy-paste typo in which the @example block for Complex32Array was annotated Complex64Array; the same defect pattern appeared in the BooleanArray interface, where the @example block carried a Complex64Array annotation instead of BooleanArray. This patch corrects that stray annotation so the documented example matches the interface it illustrates.

  • lib/node_modules/@stdlib/types/index.d.ts

be5b88f — drop redundant in order from stats/base/ndarray/* parameter docs

Follows be5b88f, which removed the redundant qualifier "in order" from containing the following ndarrays in order: headers in blas/base/ndarray/* docs; the bulleted list already implies order, making the phrase noise. This commit applies the same mechanical replacement to the equivalent headers in both README.md and docs/repl.txt for the following stats/base/ndarray packages:

  • lib/node_modules/@stdlib/stats/base/ndarray/covarmtk
  • lib/node_modules/@stdlib/stats/base/ndarray/dcovarmtk
  • lib/node_modules/@stdlib/stats/base/ndarray/dmeanstdev
  • lib/node_modules/@stdlib/stats/base/ndarray/dztest
  • lib/node_modules/@stdlib/stats/base/ndarray/dztest2
  • lib/node_modules/@stdlib/stats/base/ndarray/scovarmtk
  • lib/node_modules/@stdlib/stats/base/ndarray/sztest
  • lib/node_modules/@stdlib/stats/base/ndarray/sztest2
  • lib/node_modules/@stdlib/stats/base/ndarray/ztest
  • lib/node_modules/@stdlib/stats/base/ndarray/ztest2

JSDoc and TypeScript type stubs are unchanged, consistent with the scope of the source commit.

Related Issues

None.

Questions

No.

Other

Validation

  • Search scope: each source pattern was searched within the directories the source commit touched plus their immediate sibling namespaces (ndarray/* for the *-like test comment; lib/node_modules/@stdlib/types/ for the @example annotation; stats/base/ndarray/* for the in order qualifier). Originating packages already fixed by the source commits were excluded.
  • Independent validation: two independent Opus validation agents reviewed every candidate site by reading each file in full; both returned confirmed for all 23 sites. A separate Sonnet style-consistency agent confirmed each replacement matches the verbatim form established by the source commit.
  • Deliberately excluded:
    • The numpy migration-guide stray-bracket pattern from 5a06940 — no remaining occurrences in scope.
    • The csum @returns {number}Complex64 pattern from 09c66469 — sibling complex-sum packages already use the correct return type.
    • The "modernize examples and benchmarks" wave (~20 chore commits) — large scope, ongoing maintainer-paced rollout, not a defect of this routine's class.
    • The ## Notes JSDoc-restructuring patterns from 81d0c40, b490c625, bdc1f9b — adaptive per-site rewriting beyond mechanical analog scope.
    • The f5a9f7d "one-dimensional" qualifier additions — stats/base/ndarray/* already use the qualifier on list items.
    • Namespace re-export files (blas/ext/base/ndarray/docs/types/index.d.ts, stats/base/ndarray/docs/types/index.d.ts) — source commits left these untouched.
    • JSDoc / docs/types/index.d.ts for stats packages — source be5b88f only edited user-facing README/repl.txt; matching scope.

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 routine that scans recent develop commits for generalizable doc fixes and propagates them to sibling packages. Each propagation site was independently verified by two Opus validation agents and a Sonnet style-consistency agent before patches were applied; the changes are pure mechanical text replacements drawn verbatim from the cited source commits.



Generated by Claude Code

claude added 3 commits April 25, 2026 13:45
…ke` test comments

Propagates fix from 3ca7c21 ("docs: propagate recent `ndarray/base` comment and note fixes to sibling packages") to the top-level `ndarray/empty-like` and `ndarray/zeros-like` packages, whose `docs/types/test.ts` comments still carried the redundant "recognized/supported data type" qualifier (and a stray "is not"/"which is not" grammar slip) on the first-argument error block.
Propagates fix from 5a06940 ("docs: fix typos and examples") to a sibling `@example` block: the `BooleanArray` interface example used `const z: Complex64Array = {` instead of `BooleanArray`, mirroring the same copy-paste typo the source commit corrected on the `Complex32Array` example.
… docs

Propagates fix from be5b88f ("docs: update copy") to sibling `stats/base/ndarray/*` packages whose README and REPL help still carried the redundant "in order" qualifier on the `arrays` parameter list header. Covers covarmtk, dcovarmtk, dmeanstdev, dztest, dztest2, scovarmtk, sztest, sztest2, ztest, and ztest2.
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
ndarray/empty-like $\color{green}206/206$
$\color{green}+100.00%$
$\color{green}31/31$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}206/206$
$\color{green}+100.00%$
ndarray/zeros-like $\color{red}213/215$
$\color{green}+99.07%$
$\color{red}34/35$
$\color{green}+97.14%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{red}213/215$
$\color{green}+99.07%$
stats/base/ndarray/covarmtk $\color{green}146/146$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}146/146$
$\color{green}+100.00%$
stats/base/ndarray/dcovarmtk $\color{green}148/148$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}148/148$
$\color{green}+100.00%$
stats/base/ndarray/dmeanstdev $\color{green}129/129$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}129/129$
$\color{green}+100.00%$
stats/base/ndarray/dztest $\color{green}189/189$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}189/189$
$\color{green}+100.00%$
stats/base/ndarray/dztest2 $\color{green}203/203$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}203/203$
$\color{green}+100.00%$
stats/base/ndarray/scovarmtk $\color{green}148/148$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}148/148$
$\color{green}+100.00%$
stats/base/ndarray/sztest $\color{green}189/189$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}189/189$
$\color{green}+100.00%$
stats/base/ndarray/sztest2 $\color{green}203/203$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}203/203$
$\color{green}+100.00%$
stats/base/ndarray/ztest $\color{green}187/187$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}187/187$
$\color{green}+100.00%$
stats/base/ndarray/ztest2 $\color{green}201/201$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}201/201$
$\color{green}+100.00%$
types $\color{green}107/107$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}0/0$
$\color{green}+100.00%$
$\color{green}107/107$
$\color{green}+100.00%$

The above coverage report was generated for the changes in this PR.

@github-actions github-actions Bot mentioned this pull request Apr 25, 2026
@Planeshifter Planeshifter marked this pull request as ready for review April 25, 2026 23:06
@Planeshifter Planeshifter requested a review from a team April 25, 2026 23:06
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Apr 25, 2026
@Planeshifter Planeshifter requested a review from kgryte April 25, 2026 23:07
@kgryte kgryte added Needs Changes Pull request which needs changes before being merged. and removed Needs Review A pull request which needs code review. labels Apr 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs Changes Pull request which needs changes before being merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants