Skip to content

docs: propagate recent develop fixes to sibling packages#12642

Merged
kgryte merged 3 commits into
developfrom
philipp/fix-propagation-2026-06-06
Jun 7, 2026
Merged

docs: propagate recent develop fixes to sibling packages#12642
kgryte merged 3 commits into
developfrom
philipp/fix-propagation-2026-06-06

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

Propagating fixes merged to develop between 2026-06-05 20:40:09 -0700 (5c51a78e) and 2026-06-06 04:44:41 -0700 (f3b8c813) to sibling packages with the same underlying defect.

Pattern: missing Collection import in ndarray/base/to-unflattened declarations

This propagates the fix from 95016b8 to @stdlib/ndarray/base/to-unflattened, which has the identical defect: the sizes parameter was typed as the TypeScript built-in ArrayLike<number> rather than stdlib's Collection<number>, and the corresponding import { Collection } from '@stdlib/types/array' was absent from the declaration file. The fix adds the missing import and updates the parameter type, bringing the declaration into alignment with the rest of ndarray/base.

Pattern: drop spurious article in REPL docs

Propagates the TSDoc fix from 3116666, which dropped the ungrammatical article "a" from the phrase "if a provided broadcast-incompatible ndarrays," to the corresponding docs/repl.txt files in @stdlib/ndarray/base/maybe-broadcast-arrays, @stdlib/ndarray/maybe-broadcast-arrays, and @stdlib/ndarray/iter/interleave-subarrays. The source PR corrected the TypeScript declarations but left the same wording in the REPL help text untouched. This commit brings the three repl.txt files into agreement with the corrected declarations.

Pattern: pluralize cache-reference comments in blas/ext/base/* accessors

Propagates the comment clean-ups from f3b8c81 across sibling blas/ext/base/*/lib/accessors.js files that carry the same stale singular phrasing. Two defects are addressed per file: Defect A pluralizes // Cache reference to array data: where two or more .data buffers are cached, and Defect B pluralizes // Cache reference to the element accessors: (also dropping the redundant article) where two or more .accessors[N] entries are cached. Files with only a single such reference are left untouched, as pluralizing there would be grammatically incorrect.

  • f3b8c813 (chore: clean-up examples and benchmarks)
    • Defect A (multi-.data):
      • @stdlib/blas/ext/base/gcusumkbn
      • @stdlib/blas/ext/base/gcusumkbn2
      • @stdlib/blas/ext/base/gcusumors
      • @stdlib/blas/ext/base/gcusumpw
      • @stdlib/blas/ext/base/gnannsumkbn
      • @stdlib/blas/ext/base/gsort2hp
      • @stdlib/blas/ext/base/gsort2ins
      • @stdlib/blas/ext/base/gsort2sh
    • Defect B (multi-.accessors[N]):
      • @stdlib/blas/ext/base/gapx
      • @stdlib/blas/ext/base/gaxpb
      • @stdlib/blas/ext/base/gcusumkbn
      • @stdlib/blas/ext/base/gcusumkbn2
      • @stdlib/blas/ext/base/gcusumors
      • @stdlib/blas/ext/base/gnannsumkbn
      • @stdlib/blas/ext/base/gsort2hp
      • @stdlib/blas/ext/base/gsort2ins
      • @stdlib/blas/ext/base/gsort2sh
      • @stdlib/blas/ext/base/gsorthp
      • @stdlib/blas/ext/base/gsortins
      • @stdlib/blas/ext/base/gsortsh
      • @stdlib/blas/ext/base/gxsa

Related Issues

None.

Questions

No.

Other

Validation

  • Search scope: per pattern, scoped to the source commit's namespace first (ndarray/base/*/docs/types/*.d.ts for the missing-import sweep; **/docs/repl.txt for the broadcast-wording sweep; blas/ext/base/*/lib/accessors.js for the cache-comment sweep).
  • Two independent opus validation passes confirmed at every candidate site that (a) the defect is present as cited, (b) surrounding context does not change the semantics — for the to-unflattened declaration, that the sizes parameter is semantically a list of dimension sizes (matching unflatten's sizes semantics); for each REPL doc, that the file is hand-authored (no autogen marker) and the typo is verbatim; for each accessors file, that the comment text matches exactly and is followed by ≥2 immediately-following .data / .accessors[N] lines without an intervening blank — and (c) the proposed patch matches the source commit's exact shape.
  • An opus adaptation pass produced per-site Edits, confirming the Collection import slots in before the ndarray import (alphabetical) and matches the source-commit ordering, and that the per-file accessors.js patches each replace a unique single-line occurrence.
  • A sonnet style-consistency pass verified that each replacement matches the surrounding declaration / comment style and flagged gcusumpw's Defect-B line as already-plural (only its Defect-A line is patched here).

Deliberately excluded

  • The wider 46-site ArrayLike<number>Collection<number> sweep across ndarray/base/*/docs/types/*.d.ts: those files are not broken (TypeScript's lib provides ArrayLike as a global), so this is a codebase-convention question that should be a deliberate human decision rather than an automated propagation. Flagged for follow-up.
  • Namespace-aggregate declaration files (ndarray/docs/types/index.d.ts, ndarray/base/docs/types/index.d.ts, ndarray/iter/docs/types/index.d.ts) and the repl/help/data/data.{csv,json} files that still carry the broadcast-incompatible typo: these are generator-owned aggregates and will be regenerated from the per-package sources patched here.
  • gcusumpw Defect-B line: the comment already reads Cache references to the element accessors: (plural, but retains the redundant article). The exact source-commit old-string does not match, so this propagation deliberately does not touch it.
  • The filled(false, len)falses(len, dtype) / Uint8ArrayBooleanArray modernization in f3b8c813's examples / benchmarks / READMEs: this is an API adoption rather than a defect propagation, and applying it across blas/ext/base/* would cascade into example/benchmark rewrites that exceed self-contained-patch scope.
  • array/trues dtype-default audit (517d71c3): already correct in the new array/trues package — no propagation site.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of 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 on behalf of @Planeshifter as an automated propagation of fixes merged to develop over the prior 24 hours. Candidate source commits were filtered for generalisable patterns, sibling sites located via grep-able pattern signatures, and each proposed patch independently validated by parallel reviewer agents (two opus validation passes, one opus adaptation pass, one sonnet style-consistency pass) before commits were applied in the primary worktree. A human will audit and promote the PR out of draft.


@stdlib-js/reviewers


Generated by Claude Code

claude added 3 commits June 6, 2026 13:16
Propagates fix from 95016b8 ("fix: add missing import in `ndarray/base/unflatten` declarations") to the sibling `ndarray/base/to-unflattened` declaration, which uses bare `ArrayLike<number>` without an import.
Propagates fix from 3116666 ("docs: correct TSDoc across `ndarray` TypeScript declarations") to sibling REPL documentation. The TSDoc fix dropped the ungrammatical article "a" before "provided broadcast-incompatible ndarrays" in three `.d.ts` files; the same wording persisted in the corresponding `docs/repl.txt` files.
Propagates fix from f3b8c81 ("chore: clean-up examples and benchmarks") to sibling `blas/ext/base/*/lib/accessors.js` packages where the singular `Cache reference to ...` comment precedes multiple cached references. Edits are scoped per package: the array-data line is pluralized only where two or more `.data` buffers are cached, and the element-accessors line is pluralized (with the redundant article dropped) only where two or more `.accessors[N]` entries are cached.
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
blas/ext/base/gapx $\color{green}277/277$
$\color{green}+100.00\%$
$\color{green}23/23$
$\color{green}+100.00\%$
$\color{green}3/3$
$\color{green}+100.00\%$
$\color{green}277/277$
$\color{green}+100.00\%$
blas/ext/base/gaxpb $\color{green}290/290$
$\color{green}+100.00\%$
$\color{green}26/26$
$\color{green}+100.00\%$
$\color{green}3/3$
$\color{green}+100.00\%$
$\color{green}290/290$
$\color{green}+100.00\%$
blas/ext/base/gcusumkbn $\color{green}364/364$
$\color{green}+100.00\%$
$\color{green}31/31$
$\color{green}+100.00\%$
$\color{green}3/3$
$\color{green}+100.00\%$
$\color{green}364/364$
$\color{green}+100.00\%$
blas/ext/base/gcusumkbn2 $\color{green}386/386$
$\color{green}+100.00\%$
$\color{green}34/34$
$\color{green}+100.00\%$
$\color{green}3/3$
$\color{green}+100.00\%$
$\color{green}386/386$
$\color{green}+100.00\%$
blas/ext/base/gcusumors $\color{green}276/276$
$\color{green}+100.00\%$
$\color{green}15/15$
$\color{green}+100.00\%$
$\color{green}3/3$
$\color{green}+100.00\%$
$\color{green}276/276$
$\color{green}+100.00\%$
blas/ext/base/gcusumpw $\color{green}346/346$
$\color{green}+100.00\%$
$\color{green}18/18$
$\color{green}+100.00\%$
$\color{green}3/3$
$\color{green}+100.00\%$
$\color{green}346/346$
$\color{green}+100.00\%$
blas/ext/base/gnannsumkbn $\color{green}360/360$
$\color{green}+100.00\%$
$\color{green}28/28$
$\color{green}+100.00\%$
$\color{green}3/3$
$\color{green}+100.00\%$
$\color{green}360/360$
$\color{green}+100.00\%$
blas/ext/base/gsort2hp $\color{green}498/498$
$\color{green}+100.00\%$
$\color{green}52/52$
$\color{green}+100.00\%$
$\color{green}3/3$
$\color{green}+100.00\%$
$\color{green}498/498$
$\color{green}+100.00\%$
blas/ext/base/gsort2ins $\color{green}527/527$
$\color{green}+100.00\%$
$\color{green}62/62$
$\color{green}+100.00\%$
$\color{green}3/3$
$\color{green}+100.00\%$
$\color{green}527/527$
$\color{green}+100.00\%$
blas/ext/base/gsort2sh $\color{green}408/408$
$\color{green}+100.00\%$
$\color{green}37/37$
$\color{green}+100.00\%$
$\color{green}3/3$
$\color{green}+100.00\%$
$\color{green}408/408$
$\color{green}+100.00\%$
blas/ext/base/gsorthp $\color{green}430/430$
$\color{green}+100.00\%$
$\color{green}51/51$
$\color{green}+100.00\%$
$\color{green}3/3$
$\color{green}+100.00\%$
$\color{green}430/430$
$\color{green}+100.00\%$
blas/ext/base/gsortins $\color{green}419/419$
$\color{green}+100.00\%$
$\color{green}61/61$
$\color{green}+100.00\%$
$\color{green}3/3$
$\color{green}+100.00\%$
$\color{green}419/419$
$\color{green}+100.00\%$
blas/ext/base/gsortsh $\color{green}348/348$
$\color{green}+100.00\%$
$\color{green}36/36$
$\color{green}+100.00\%$
$\color{green}3/3$
$\color{green}+100.00\%$
$\color{green}348/348$
$\color{green}+100.00\%$
blas/ext/base/gxsa $\color{green}277/277$
$\color{green}+100.00\%$
$\color{green}23/23$
$\color{green}+100.00\%$
$\color{green}3/3$
$\color{green}+100.00\%$
$\color{green}277/277$
$\color{green}+100.00\%$
ndarray/base/maybe-broadcast-arrays $\color{green}183/183$
$\color{green}+100.00\%$
$\color{green}8/8$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}183/183$
$\color{green}+100.00\%$
ndarray/base/to-unflattened $\color{green}112/112$
$\color{green}+100.00\%$
$\color{green}3/3$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}112/112$
$\color{green}+100.00\%$
ndarray/iter/interleave-subarrays $\color{green}279/279$
$\color{green}+100.00\%$
$\color{green}28/28$
$\color{green}+100.00\%$
$\color{green}4/4$
$\color{green}+100.00\%$
$\color{green}279/279$
$\color{green}+100.00\%$
ndarray/maybe-broadcast-arrays $\color{green}244/244$
$\color{green}+100.00\%$
$\color{green}20/20$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}244/244$
$\color{green}+100.00\%$

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

@kgryte kgryte changed the title fix: propagate recent develop fixes to sibling packages (2026-06-06) docs: propagate recent develop fixes to sibling packages (2026-06-06) Jun 7, 2026
@kgryte kgryte marked this pull request as ready for review June 7, 2026 00:34
@kgryte kgryte requested a review from a team June 7, 2026 00:34
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jun 7, 2026
@kgryte kgryte changed the title docs: propagate recent develop fixes to sibling packages (2026-06-06) docs: propagate recent develop fixes to sibling packages Jun 7, 2026
@kgryte kgryte merged commit cd863cf into develop Jun 7, 2026
39 checks passed
@kgryte kgryte deleted the philipp/fix-propagation-2026-06-06 branch June 7, 2026 00:38
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Jun 7, 2026
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