Skip to content

docs: propagate fixes across _tools and blas/base/ndarray siblings#12287

Draft
Planeshifter wants to merge 2 commits into
developfrom
philipp/fix-propagation-2026-05-25
Draft

docs: propagate fixes across _tools and blas/base/ndarray siblings#12287
Planeshifter wants to merge 2 commits into
developfrom
philipp/fix-propagation-2026-05-25

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

Propagating fixes merged to develop between 2026-05-24 19:39 UTC and 2026-05-25 10:04 UTC to sibling packages with the same underlying defect.

@throws {TypeError}@throws {Error} for catch-all option validation

Propagates the @throws {Error} fix from 09c01f1 to 37 sites across 21 _tools/ packages where the same annotation was incorrectly typed as @throws {TypeError}. Each affected lib/validate.js returns a plain Error for at least one constraint — pattern suffix, protocol enum, or name prefix — making TypeError wrong in all cases.

Source: 09c01f1 ("docs: fix @throws annotation in blas/ext/one-to and blas/ext/zero-to")

Targets:

  • _tools/pkgs/types (lib/main.js, lib/sync.js)
  • _tools/pkgs/readmes (lib/main.js, lib/sync.js)
  • _tools/pkgs/repl-help (lib/main.js, lib/sync.js)
  • _tools/pkgs/includes (lib/main.js, lib/sync.js)
  • _tools/pkgs/namespace-readmes (lib/main.js, lib/sync.js)
  • _tools/pkgs/namespaces (lib/async.js, lib/sync.js)
  • _tools/pkgs/toposort (lib/async.js, lib/sync.js)
  • _tools/pkgs/tree (lib/async.js, lib/sync.js)
  • _tools/pkgs/cmds (lib/async.js, lib/sync.js)
  • _tools/pkgs/wasm (lib/async.js, lib/sync.js)
  • _tools/pkgs/addons (lib/async.js, lib/sync.js)
  • _tools/pkgs/names (lib/async.js, lib/sync.js)
  • _tools/pkgs/browser-compatible (lib/async.js, lib/sync.js)
  • _tools/pkgs/standalones (lib/async.js, lib/sync.js)
  • _tools/pkgs/clis (lib/async.js, lib/sync.js)
  • _tools/scaffold/package-json (lib/main.js)
  • _tools/github/create-issue (lib/main.js)
  • _tools/github/dispatch-workflow (lib/main.js)
  • _tools/lint/pkg-json (lib/async.js, lib/sync.js)
  • _tools/docs/www/readme-fragment-file-tree (lib/main.js)
  • _tools/docs/www/readme-database (lib/main.js)

Missing ndarray/ segment in HTML-comment <img> URLs

Propagates the ndarray/ path correction from 6742bc8 to the six remaining sibling packages that carry the same stale <img> URL prefix, where the ndarray/ segment was dropped from the docs/img/ path, causing 404s. All affected lines follow the identical pattern corrected in dznrm2 and scnrm2.

Source: 6742bc8 ("docs: follow-up fixes for commits merged to develop on 2026-05-24")

Targets:

  • blas/base/ndarray/dasum/README.md
  • blas/base/ndarray/gasum/README.md
  • blas/base/ndarray/sasum/README.md
  • blas/base/ndarray/dnrm2/README.md
  • blas/base/ndarray/gnrm2/README.md
  • blas/base/ndarray/snrm2/README.md

Related Issues

No.

Questions

No.

Other

Validation

  • Searched all of lib/node_modules/@stdlib/ for the @throws {TypeError} must provide valid options JSDoc string (126 raw hits) and confirmed each of the 37 confirmed sites by reading the corresponding lib/validate.js to verify it returns new Error(...) for at least one option constraint; the remaining 89 hits live in packages whose validators only throw TypeError/RangeError and were left untouched.
  • Searched lib/node_modules/@stdlib/blas/base/ndarray/ for HTML-comment &lt;img src="..."&gt; URLs whose path omits the ndarray/ segment and confirmed each of the 6 sites; ddot, gdot, and sdot already carried the correct path and were excluded.
  • Two independent validation passes confirmed defect presence at each site; an adaptation pass produced the per-site patch; a style-consistency pass verified column alignment and surrounding-context conformance.

Deliberately excluded

  • Source 8fdaa49 ("refactor: use format for error construction in stats/incr/pcorrmat") — exhaustive search of stats/{incr,base,strided}/* found zero remaining sites with raw string concatenation inside throw new Error(...). The originating commit was the last instance.
  • Source 88e02d5 ("docs: update assert TypeScript declaration examples") — the target file lib/node_modules/@stdlib/assert/docs/types/index.d.ts is regenerated daily by the namespace_declarations.yml workflow via _tools/scripts/create_namespace_types.js from per-package docs/types/index.d.ts examples; propagating into the namespace file would be overwritten on the next run, and the upstream per-package modernization (is-complex128matrix-like, commit 00c05b8 from 2026-05-23) is outside the 24-hour window.
  • Source 6742bc8 Pattern A (float16ArrayFloat16Array typo) — no additional instances exist anywhere in the tree.

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 the automated fix-propagation routine. The candidate-site enumeration, per-site validation, and patch application were performed by AI agents under a fixed routine; each site was independently confirmed against the source package's validate.js (Pattern 1) or the README path layout (Pattern 2) before the patch was applied. A maintainer should review classification and contents before promoting this draft.


@stdlib-js/reviewers


Generated by Claude Code

claude added 2 commits May 25, 2026 13:32
Replaces the `@throws {TypeError} must provide valid options` JSDoc
annotation with `@throws {Error} must provide valid options` in 37 files
across 21 `_tools/` packages whose `validate.js` returns a plain `Error`
(not `TypeError`) for at least one non-type constraint (e.g., `pattern`
suffix, `protocol` enum, `name` prefix).

Propagates fix from 09c01f1 ("docs: fix `@throws` annotation in
`blas/ext/one-to` and `blas/ext/zero-to`") to sibling packages exhibiting
the same defect.
Inserts the missing `ndarray/` segment in HTML-comment `<img>` URLs that
still pointed at `blas/base/<pkg>/docs/img/...` instead of
`blas/base/ndarray/<pkg>/docs/img/...` in six package READMEs (`dasum`,
`gasum`, `sasum`, `dnrm2`, `gnrm2`, `snrm2`).

Propagates fix from 6742bc8 ("docs: follow-up fixes for commits merged
to `develop` on 2026-05-24") to sibling packages with the same stale
path.
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
blas/base/ndarray/dasum $\color{green}103/103$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}103/103$
$\color{green}+100.00%$
blas/base/ndarray/dnrm2 $\color{green}103/103$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}103/103$
$\color{green}+100.00%$
blas/base/ndarray/gasum $\color{green}103/103$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}103/103$
$\color{green}+100.00%$
blas/base/ndarray/gnrm2 $\color{green}103/103$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}103/103$
$\color{green}+100.00%$
blas/base/ndarray/sasum $\color{green}103/103$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}103/103$
$\color{green}+100.00%$
blas/base/ndarray/snrm2 $\color{green}103/103$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}103/103$
$\color{green}+100.00%$

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


<!-- <div class="equation" align="center" data-raw-text="\|\mathbf{x}\|_2 = \sqrt{x_0^2 + x_1^2 + \ldots + x_{N-1}^2}" data-equation="eq:l2_norm">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@f766d7eeb56ff14cbceeeeef03d7f7b88c467515/lib/node_modules/@stdlib/blas/base/dnrm2/docs/img/equation_l2_norm.svg" alt="L2-norm definition.">
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@f766d7eeb56ff14cbceeeeef03d7f7b88c467515/lib/node_modules/@stdlib/blas/base/ndarray/dnrm2/docs/img/equation_l2_norm.svg" alt="L2-norm definition.">
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove all the changes to HTML-comment URLs in this PR.

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.

3 participants