chore: clean-up#13551
Merged
Merged
Conversation
…ay/dsyr2` - fix ndarray argument order in TypeScript declaration tests to match the documented `[ x, y, A, uplo, alpha ]` calling convention - add missing JSDoc `@example` tag in `lib/main.js` - use imperative mood in README tagline and `package.json` description to match sibling packages
…syr2` - add missing JSDoc `@example` tag in `lib/main.js` - use imperative mood in README tagline and `package.json` description to match sibling packages
…as/ext/base/ndarray/gany` - use single-input parameter phrasing in README to match `dany` and `sany` siblings and the package's own `repl.txt` - use `typedndarray<unknown>` in the TypeScript declaration to match the convention of generic ndarray routines in the same directory
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
marked this pull request as ready for review
July 19, 2026 20:03
kgryte
approved these changes
Jul 19, 2026
blas/base/ndarray/dsyr2, blas/base/ndarray/ssyr2, and blas/ext/base/ndarray/gany
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
This pull request applies follow-up fixes for commits merged to
developbetween 2026-07-18 14:43 (PT) (c624655a) and 2026-07-19 02:10 (PT) (ad17191d).blas/base/ndarray/dsyr2blas/base/ndarray/dsyr2):docs/types/test.tslines 45 and 80 calldsyr2( [ A, x, y, uplo, alpha ] ); every other call site in the package—and ssyr2'stest.ts—use[ x, y, A, uplo, alpha ]. Reorder both arrays to match.dsyr2'smain.jsJSDoc drops the@exampletag before the example code — goes straight from@returnsto therequirecalls, so the block isn't recognized as an example. dsyr/ssyr/gsyr all have it; add* @exampleafter@returnsinlib/node_modules/@stdlib/blas/base/ndarray/dsyr2/lib/main.js.blas/base/ndarray/dsyr2/README.md(L23) andpackage.jsonwith "Performs the symmetric rank 2 operation ..." instead of the imperative "Perform" used everywhere else inblas/base/ndarray(dsyr, ssyr, gsyr, dgemm, etc.); fixed both to match the established convention.blas/base/ndarray/ssyr2blas/base/ndarray/ssyr2/lib/main.jsis missing@examplebefore the example code in the main export's JSDoc — every sibling (dsyr, ssyr, gsyr) has it. Added* @exampleafter@returnsso doc tooling picks up the example block.package.jsondescription forblas/base/ndarray/ssyr2say "Performs the symmetric rank 2 operation" — every sibling ndarray package uses the imperative "Perform ...". Fixed both to match (README.md line 23,package.jsondescription).blas/ext/base/ndarray/ganyganytakes one ndarray, contradicting its ownrepl.txtand dany/sany. Switched to the flat "array-like object containing a one-dimensional input ndarray" phrasing inlib/node_modules/@stdlib/blas/ext/base/ndarray/gany/README.md.gany's d.ts (lib/node_modules/@stdlib/blas/ext/base/ndarray/gany/docs/types/index.d.ts) typesarraysas barendarrayinstead oftypedndarray<unknown>, unlike every other g-prefixed sibling inext/base/ndarray(gindex-of-truthy/gindex-of-falsy included). Importtypedndarrayand fix the signature togany( arrays: [ typedndarray<unknown> ] ): boolean.Related Issues
This pull request does not have any related issues.
Questions
No.
Other
Validation performed on the 49-commit window (
c624655a..ad17191d):docs/style-guidesand established sibling packages of similar complexity.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was generated by Claude Code as part of an automated follow-up review of commits recently merged to
develop. All findings were machine-verified against the repository before committing; a human maintainer will audit the changes before this PR is marked ready for review.Generated by Claude Code