docs: propagate fixes across _tools and blas/base/ndarray siblings#12287
Draft
Planeshifter wants to merge 2 commits into
Draft
docs: propagate fixes across _tools and blas/base/ndarray siblings#12287Planeshifter wants to merge 2 commits into
_tools and blas/base/ndarray siblings#12287Planeshifter wants to merge 2 commits into
Conversation
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.
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-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 validationPropagates the
@throws {Error}fix from 09c01f1 to 37 sites across 21_tools/packages where the same annotation was incorrectly typed as@throws {TypeError}. Each affectedlib/validate.jsreturns a plainErrorfor at least one constraint —patternsuffix,protocolenum, ornameprefix — makingTypeErrorwrong in all cases.Source: 09c01f1 ("docs: fix
@throwsannotation inblas/ext/one-toandblas/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>URLsPropagates the
ndarray/path correction from 6742bc8 to the six remaining sibling packages that carry the same stale<img>URL prefix, where thendarray/segment was dropped from thedocs/img/path, causing 404s. All affected lines follow the identical pattern corrected indznrm2andscnrm2.Source: 6742bc8 ("docs: follow-up fixes for commits merged to
developon 2026-05-24")Targets:
blas/base/ndarray/dasum/README.mdblas/base/ndarray/gasum/README.mdblas/base/ndarray/sasum/README.mdblas/base/ndarray/dnrm2/README.mdblas/base/ndarray/gnrm2/README.mdblas/base/ndarray/snrm2/README.mdRelated Issues
No.
Questions
No.
Other
Validation
lib/node_modules/@stdlib/for the@throws {TypeError} must provide valid optionsJSDoc string (126 raw hits) and confirmed each of the 37 confirmed sites by reading the correspondinglib/validate.jsto verify it returnsnew Error(...)for at least one option constraint; the remaining 89 hits live in packages whose validators only throwTypeError/RangeErrorand were left untouched.lib/node_modules/@stdlib/blas/base/ndarray/for HTML-comment<img src="...">URLs whose path omits thendarray/segment and confirmed each of the 6 sites;ddot,gdot, andsdotalready carried the correct path and were excluded.Deliberately excluded
formatfor error construction instats/incr/pcorrmat") — exhaustive search ofstats/{incr,base,strided}/*found zero remaining sites with raw string concatenation insidethrow new Error(...). The originating commit was the last instance.assertTypeScript declaration examples") — the target filelib/node_modules/@stdlib/assert/docs/types/index.d.tsis regenerated daily by thenamespace_declarations.ymlworkflow via_tools/scripts/create_namespace_types.jsfrom per-packagedocs/types/index.d.tsexamples; 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.float16Array→Float16Arraytypo) — no additional instances exist anywhere in the tree.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 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