docs: update x JSDoc type in @stdlib/blas/ext/sum#12645
Merged
Conversation
Change the JSDoc `@param` annotation for `x` from `{ndarray}` to
`{ndarrayLike}` in `lib/main.js`. The bare `{ndarray}` type was the
sole outlier among the 12 `@stdlib/blas/ext/*` sibling packages whose
primary function accepts `x` as its first parameter: 11/12 (~92%)
use `{ndarrayLike}`. The narrower type also contradicted this
package's own `@throws` clause two lines below, which states that
`x` "must be an ndarray-like object".
stdlib-bot
added
the
BLAS
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
approved these changes
Jun 7, 2026
kgryte
added
the
Documentation
kgryte
changed the title
x JSDoc type in @stdlib/blas/ext/sumx JSDoc type in @stdlib/blas/ext/sum
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
4 participants
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
@stdlib/blas/ext/sum: widen the JSDoc@paramtype forxinlib/main.jsfrom{ndarray}to{ndarrayLike}.sumwas the sole outlier among the 12blas/ext/*sibling packages whose primary function takesxas its first parameter — 11/12 (~92%) use{ndarrayLike}. The narrower type also contradicted this package's own@throwsclause two lines below, which states thatx"must be an ndarray-like object", and the underlyingndarray/base/unary-reduce-strided1d-dispatch-factoryit wraps documents its input parameter the same way. Pure documentation change; no source, test, or behavioral changes.Related Issues
This pull request has no related issues.
Questions
No.
Other
No.
Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code via the cross-package drift-detection routine: structural and semantic features were extracted from every direct-child leaf member of
@stdlib/blas/ext, majority patterns were computed at a 75% conformance threshold, and two independent opus validation agents (semantic-review, cross-reference) confirmed the candidate before any file was edited. The diff is a single JSDoc-type-tag change on one line.@stdlib-js/reviewers
Generated by Claude Code