fix: use correct argument value in error message and propagate JSDoc fixes to sibling packages#12302
Merged
Merged
Conversation
Propagates fix from 6c22721 ("fix: use correct argument in `blas/base/dgemm`") to sibling packages with the same zero-stride validation error reporting `strideX` instead of `strideY`.
Propagates fix from 8f8c656 ("docs: align `alpha` description in `blas/ext/base/gxsa`") to sibling packages where the `alpha` or `beta` JSDoc description is "scalar" instead of the canonical "scalar constant" used elsewhere in the same packages' declared types.
Propagates fix from 4531b43 ("docs: fix JSDoc text") to a sibling constant-value module whose `@module` description used the imperative "Return a boolean ..." instead of the noun phrase used by `is-big-endian`, `is-darwin`, and `is-windows`.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
develop argument and JSDoc fixes to sibling packagesdevelop argument and JSDoc fixes to sibling packages
kgryte
approved these changes
May 27, 2026
develop argument and JSDoc fixes to sibling packages
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-25 13:11 UTC and 2026-05-26 13:11 UTC to sibling packages.fix:use correct argument informat()error messageblas/base/dgemmhad aRangeErrorforN < 0whoseformat()value interpolatedMinstead ofN. Three*syr2siblings carry the analogous defect: the zero-stride check onstrideYreportsstrideX. The non-nativessyr2.js(and bothndarray.jsfiles) already reportstrideYcorrectly, confirming the helper-file copy-paste.blas/base/ssyr2/lib/ssyr2.native.jsblas/base/dsyr2/lib/dsyr2.jsblas/base/dsyr2/lib/dsyr2.native.jsdocs:align scalar parameter descriptions to package styleblas/ext/base/gxsaaligned* @param {number} alpha - scalarto... - scalar constantto match the package's declared types. The same wording mismatch lives in eighteen BLAS helper files wherealphaorbetais documented as justscalarwhile the package's ownindex.d.ts(and, for the GEMM helpers, the sibling JSDoc later in the same file) usesscalar constant.blas/base/sspr(ndarray.js,sspr.js,ndarray.native.js,base.js,sspr.native.js)blas/base/dspr(ndarray.js,dspr.js,base.js)blas/base/ssyr2(ndarray.js,ssyr2.js,base.js)blas/base/gscal(ndarray.js,accessors.js)blas/ext/base/gapx(ndarray.js)blas/base/dgemm/lib/base.js,blas/base/sgemm/lib/base.jsblas/base/ggemm(base.js,accessors.js)docs:convert imperative to noun phrase in constant-module JSDocos/num-cpuschanged its@moduledescription fromReturn the number of CPUs.toNumber of CPUs.because the module exports a value, not a function.assert/is-little-endianis the lone outlier among theis-*endian/platform constants —is-big-endian,is-darwin, andis-windowsall use the noun phrase.assert/is-little-endian/lib/index.jsRelated Issues
None.
Questions
No.
Other
Validation
Search scope was
lib/node_modules/@stdlib/blas/**(Patterns A and B) andlib/node_modules/@stdlib/**/lib/index.jsexporting constants (Pattern C). Each site was independently confirmed by two opus validation agents, verified for self-containment by an adaptation pass, and checked for style consistency against the package's own d.ts / siblings by a final pass.Deliberately excluded:
alpha - scalarJSDoc lives in packages whose canonical wording is just "constant" (e.g.,*scal,*axpy,*fill,gaxpy,wasm/*scal,wasm/*axpy) — these require human judgment about which canonical wording the package should adopt.tempory → temporarytypo pattern from 4531b43 — zero additional occurrences in the repo.throw new ...( format(...) )mismatches in BLAS that, on inspection, turned out to be intentional (e.g.,transAreported whenta = resolveStr(transA)is null;LDAbound variables computed fromorder).No
refactor:commits propagated this run —b3c6c81b/04fe53bd(isMatrixTranspose→resolveStrinsgemm/ggemm) change signatures and warrant human review before being applied todgemmand the complex GEMM variants.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was prepared by Claude Code as part of an automated fix-propagation routine. Each propagation site was independently confirmed by two opus validation agents and a style-consistency pass before patches were applied; the routine refuses to propagate any site that fails consensus.
@stdlib-js/reviewers
Generated by Claude Code