docs: propagate recent doc fixes to sibling ndarray, stats/base/ndarray, and types packages#11777
Open
Planeshifter wants to merge 3 commits intodevelopfrom
Open
docs: propagate recent doc fixes to sibling ndarray, stats/base/ndarray, and types packages#11777Planeshifter wants to merge 3 commits intodevelopfrom
ndarray, stats/base/ndarray, and types packages#11777Planeshifter wants to merge 3 commits intodevelopfrom
Conversation
…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.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
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.
Description
Propagating fixes merged to
developbetween 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*-liketest commentsPropagates the fix from
3ca7c21— dropping the verbose"having a recognized/supported data type"qualifier from the first-argument$ExpectErrorblock 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.tslib/node_modules/@stdlib/ndarray/zeros-like/docs/types/test.ts5a06940— fixBooleanArray@exampleannotation typoCommit
5a06940fixed a copy-paste typo in which the@exampleblock forComplex32Arraywas annotatedComplex64Array; the same defect pattern appeared in theBooleanArrayinterface, where the@exampleblock carried aComplex64Arrayannotation instead ofBooleanArray. This patch corrects that stray annotation so the documented example matches the interface it illustrates.lib/node_modules/@stdlib/types/index.d.tsbe5b88f— drop redundantin orderfromstats/base/ndarray/*parameter docsFollows
be5b88f, which removed the redundant qualifier "in order" fromcontaining the following ndarrays in order:headers inblas/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 bothREADME.mdanddocs/repl.txtfor the followingstats/base/ndarraypackages:lib/node_modules/@stdlib/stats/base/ndarray/covarmtklib/node_modules/@stdlib/stats/base/ndarray/dcovarmtklib/node_modules/@stdlib/stats/base/ndarray/dmeanstdevlib/node_modules/@stdlib/stats/base/ndarray/dztestlib/node_modules/@stdlib/stats/base/ndarray/dztest2lib/node_modules/@stdlib/stats/base/ndarray/scovarmtklib/node_modules/@stdlib/stats/base/ndarray/sztestlib/node_modules/@stdlib/stats/base/ndarray/sztest2lib/node_modules/@stdlib/stats/base/ndarray/ztestlib/node_modules/@stdlib/stats/base/ndarray/ztest2JSDoc and TypeScript type stubs are unchanged, consistent with the scope of the source commit.
Related Issues
None.
Questions
No.
Other
Validation
ndarray/*for the*-liketest comment;lib/node_modules/@stdlib/types/for the@exampleannotation;stats/base/ndarray/*for thein orderqualifier). Originating packages already fixed by the source commits were excluded.confirmedfor all 23 sites. A separate Sonnet style-consistency agent confirmed each replacement matches the verbatim form established by the source commit.numpymigration-guide stray-bracket pattern from5a06940— no remaining occurrences in scope.csum@returns {number}→Complex64pattern from09c66469— sibling complex-sum packages already use the correct return type.## NotesJSDoc-restructuring patterns from81d0c40,b490c625,bdc1f9b— adaptive per-site rewriting beyond mechanical analog scope.f5a9f7d"one-dimensional" qualifier additions —stats/base/ndarray/*already use the qualifier on list items.blas/ext/base/ndarray/docs/types/index.d.ts,stats/base/ndarray/docs/types/index.d.ts) — source commits left these untouched.docs/types/index.d.tsfor stats packages — sourcebe5b88fonly edited user-facing README/repl.txt; matching scope.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 routine that scans recent
developcommits 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