docs: propagate recent ndarray/base comment and note fixes to sibling packages#11762
Merged
docs: propagate recent ndarray/base comment and note fixes to sibling packages#11762
ndarray/base comment and note fixes to sibling packages#11762Conversation
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.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
approved these changes
Apr 24, 2026
Member
|
As the CI failure is not due to changes introduced in this PR, I'll go ahead and merge. |
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-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:
b5fb2f8tondarray/base/rot90/lib/main.js, which carried the same JSDoc note as the README / REPL help / type declarations already corrected in that commit.1bb47ae/8c95fbfto four sibling packages underndarray/base/(empty-like,ones-like,zeros-like,transpose) whosedocs/types/test.tsfiles carry the same stale comment above an identical non-ndarray$ExpectErrorblock.b5fb2f8— clockwise rotation noteb5fb2f8 corrected the clockwise rotation note across
README.md,docs/repl.txt, anddocs/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 ofk, not by swapping thedimsargument. That commit did not touchlib/main.js, which carries the identical JSDoc note and contained the same erroneousdims = [1, 0]. This PR applies the missing correction tolib/main.js.lib/node_modules/@stdlib/ndarray/base/rot90/lib/main.js1bb47ae/8c95fbf— TS test$ExpectErrorcommentPropagates the comment fix from
8c95fbf(ndarray/base/rotl90) and1bb47ae(ndarray/base/rotr90) to the TypeScript test files forndarray/base/empty-like,ndarray/base/ones-like,ndarray/base/zeros-like, andndarray/base/transpose. Each of those files carried the same stale comment — "...not an ndarray having a recognized/supported data type..." — above a$ExpectErrorblock 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.tslib/node_modules/@stdlib/ndarray/base/ones-like/docs/types/test.tslib/node_modules/@stdlib/ndarray/base/zeros-like/docs/types/test.tslib/node_modules/@stdlib/ndarray/base/transpose/docs/types/test.tsRelated Issues
No.
Questions
No.
Other
Validation
lib/node_modules/@stdlib/ndarray/for both patterns (sibling namespace of the originating packages).ndarray/base/rot90README/types/repl for Pattern A;ndarray/base/rotl90andndarray/base/rotr90TS tests for Pattern B).Deliberately excluded
stats/base/dists/gamma/logcdf/README.md— structurally parallels thestats/base/dists/chi/cdf/README.mdfix from41606e2(wrong heading levels, missing<section class="c">wrapper, JS## Examplesafter 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 asneeds-human; applying the 4-step restructuring cleanly requires additional judgment to rebalance tags. Dropped from this run.docs/migration-guides/numpy/README.mdfixes from588cd1d/0e262c8— localized to the single migration guide; no sibling sites.blas/ext/to-sortedhpassertion/description fixes from3bd03310— 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
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code as part of an automated fix-propagation routine that reviews commits merged to
developover 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