Skip to content

docs: propagate recent ndarray/base comment and note fixes to sibling packages#11762

Merged
kgryte merged 2 commits intodevelopfrom
philipp/fix-propagation-2026-04-24
Apr 24, 2026
Merged

docs: propagate recent ndarray/base comment and note fixes to sibling packages#11762
kgryte merged 2 commits intodevelopfrom
philipp/fix-propagation-2026-04-24

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Propagating fixes merged to develop between 2026-04-23 15:41 UTC-7 and 2026-04-24 05:33 UTC-7 to sibling packages that carry the same defect.

Description

This pull request:

  • Propagates the clockwise-rotation note correction from b5fb2f8 to ndarray/base/rot90/lib/main.js, which carried the same JSDoc note as the README / REPL help / type declarations already corrected in that commit.
  • Propagates the TS test comment trim from 1bb47ae / 8c95fbf to four sibling packages under ndarray/base/ (empty-like, ones-like, zeros-like, transpose) whose docs/types/test.ts files carry the same stale comment above an identical non-ndarray $ExpectError block.

b5fb2f8 — clockwise rotation note

b5fb2f8 corrected the clockwise rotation note across README.md, docs/repl.txt, and docs/types/index.d.ts, changing the example dimension array from [1, 0] to [0, 1] so that the note is consistent with the counterclockwise case directly above it — rotation direction is determined by the sign of k, not by swapping the dims argument. That commit did not touch lib/main.js, which carries the identical JSDoc note and contained the same erroneous dims = [1, 0]. This PR applies the missing correction to lib/main.js.

  • lib/node_modules/@stdlib/ndarray/base/rot90/lib/main.js

1bb47ae / 8c95fbf — TS test $ExpectError comment

Propagates the comment fix from 8c95fbf (ndarray/base/rotl90) and 1bb47ae (ndarray/base/rotr90) to the TypeScript test files for ndarray/base/empty-like, ndarray/base/ones-like, ndarray/base/zeros-like, and ndarray/base/transpose. Each of those files carried the same stale comment — "...not an ndarray having a recognized/supported data type..." — above a $ExpectError block that only tests non-ndarray values (strings, numbers, booleans, etc.), making the "recognized/supported data type" qualifier incorrect. The comment is trimmed to "...not an ndarray..." to accurately reflect what the block actually tests.

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

Related Issues

No.

Questions

No.

Other

Validation

  • Pattern search scope: lib/node_modules/@stdlib/ndarray/ for both patterns (sibling namespace of the originating packages).
  • Two independent validation passes on each target site, each agent reading the full target file.
  • Style-consistency pass against the post-fix state of the source packages (ndarray/base/rot90 README/types/repl for Pattern A; ndarray/base/rotl90 and ndarray/base/rotr90 TS tests for Pattern B).

Deliberately excluded

  • stats/base/dists/gamma/logcdf/README.md — structurally parallels the stats/base/dists/chi/cdf/README.md fix from 41606e2 (wrong heading levels, missing <section class="c"> wrapper, JS ## Examples after C APIs), but the file's JS <section class="usage"> closer is misplaced such that it swallows the entire C APIs block. Both independent validation agents flagged this as needs-human; applying the 4-step restructuring cleanly requires additional judgment to rebalance tags. Dropped from this run.
  • docs/migration-guides/numpy/README.md fixes from 588cd1d / 0e262c8 — localized to the single migration guide; no sibling sites.
  • blas/ext/to-sortedhp assertion/description fixes from 3bd03310 — package-specific; the one grep-able typo ("support string" vs "supported string") has no other occurrences in the repo outside that commit.

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 an automated fix-propagation routine that reviews commits merged to develop over a 24-hour window and applies the equivalent fix at validated sibling sites. Each proposed site was validated by two independent agents and passed a style-consistency pass before inclusion. A maintainer will audit before promotion from draft.


@stdlib-js/reviewers


Generated by Claude Code

claude added 2 commits April 24, 2026 13:21
Propagates fix from b5fb2f8 ("docs: update notes") to `lib/main.js`, which was missed when the same `dims = [1, 0]` typo was corrected in README.md, docs/repl.txt, and docs/types/index.d.ts. The sign of `k` determines rotation direction; the canonical example should reference `dims = [0, 1]` to mirror the counterclockwise note immediately above.
…ke,transpose}`

Propagates fix from 1bb47ae / 8c95fbf ("docs: fix comment") to sibling packages whose TS test files carry the same inaccurate `$ExpectError` block comment. The following block only tests non-ndarray values (strings, numbers, booleans, null, arrays, objects, functions), so the "having a recognized/supported data type" qualifier does not describe what the compiler actually rejects.
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
ndarray/base/empty-like $\color{green}149/149$
$\color{green}+100.00%$
$\color{green}9/9$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}149/149$
$\color{green}+100.00%$
ndarray/base/ones-like $\color{green}111/111$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}111/111$
$\color{green}+100.00%$
ndarray/base/rot90 $\color{green}182/182$
$\color{green}+100.00%$
$\color{green}19/19$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}182/182$
$\color{green}+100.00%$
ndarray/base/transpose $\color{green}131/131$
$\color{green}+100.00%$
$\color{green}5/5$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}131/131$
$\color{green}+100.00%$
ndarray/base/zeros-like $\color{green}142/142$
$\color{green}+100.00%$
$\color{green}8/8$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}142/142$
$\color{green}+100.00%$

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

@kgryte kgryte added bot: Merge Pull request needing the latest project code be merged in. and removed bot: Merge Pull request needing the latest project code be merged in. labels Apr 24, 2026
@kgryte kgryte marked this pull request as ready for review April 24, 2026 22:50
@kgryte kgryte requested a review from a team April 24, 2026 22:50
@kgryte
Copy link
Copy Markdown
Member

kgryte commented Apr 24, 2026

As the CI failure is not due to changes introduced in this PR, I'll go ahead and merge.

@kgryte kgryte merged commit 3ca7c21 into develop Apr 24, 2026
33 of 36 checks passed
@kgryte kgryte deleted the philipp/fix-propagation-2026-04-24 branch April 24, 2026 22:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants