Skip to content

chore: clean-up#13551

Merged
kgryte merged 3 commits into
developfrom
philipp/fix-commit-review-2026-07-19
Jul 19, 2026
Merged

chore: clean-up#13551
kgryte merged 3 commits into
developfrom
philipp/fix-commit-review-2026-07-19

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request applies follow-up fixes for commits merged to develop between 2026-07-18 14:43 (PT) (c624655a) and 2026-07-19 02:10 (PT) (ad17191d).

blas/base/ndarray/dsyr2

  • 314e509 (blas/base/ndarray/dsyr2): docs/types/test.ts lines 45 and 80 call dsyr2( [ A, x, y, uplo, alpha ] ); every other call site in the package—and ssyr2's test.ts—use [ x, y, A, uplo, alpha ]. Reorder both arrays to match.
  • 314e509: dsyr2's main.js JSDoc drops the @example tag before the example code — goes straight from @returns to the require calls, so the block isn't recognized as an example. dsyr/ssyr/gsyr all have it; add * @example after @returns in lib/node_modules/@stdlib/blas/base/ndarray/dsyr2/lib/main.js.
  • 314e509 introduced blas/base/ndarray/dsyr2/README.md (L23) and package.json with "Performs the symmetric rank 2 operation ..." instead of the imperative "Perform" used everywhere else in blas/base/ndarray (dsyr, ssyr, gsyr, dgemm, etc.); fixed both to match the established convention.

blas/base/ndarray/ssyr2

  • 8b15f44: blas/base/ndarray/ssyr2/lib/main.js is missing @example before the example code in the main export's JSDoc — every sibling (dsyr, ssyr, gsyr) has it. Added * @example after @returns so doc tooling picks up the example block.
  • 8b15f44: README tagline and package.json description for blas/base/ndarray/ssyr2 say "Performs the symmetric rank 2 operation" — every sibling ndarray package uses the imperative "Perform ...". Fixed both to match (README.md line 23, package.json description).

blas/ext/base/ndarray/gany

  • 3314d55: README params use the nested "array-like object containing the following ndarrays:" template meant for multi-array functions, but gany takes one ndarray, contradicting its own repl.txt and dany/sany. Switched to the flat "array-like object containing a one-dimensional input ndarray" phrasing in lib/node_modules/@stdlib/blas/ext/base/ndarray/gany/README.md.
  • 3314d55: gany's d.ts (lib/node_modules/@stdlib/blas/ext/base/ndarray/gany/docs/types/index.d.ts) types arrays as bare ndarray instead of typedndarray<unknown>, unlike every other g-prefixed sibling in ext/base/ndarray (gindex-of-truthy/gindex-of-falsy included). Import typedndarray and fix the signature to gany( arrays: [ typedndarray<unknown> ] ): boolean.

Related Issues

Does this pull request have any related issues?

This pull request does not have any related issues.

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

Validation performed on the 49-commit window (c624655a..ad17191d):

  • Style guide compliance: two independent review passes comparing each new package against docs/style-guides and established sibling packages of similar complexity.
  • Bug scan: two independent review passes over the per-commit diffs (diff-only and in-context); no runtime bugs found.
  • Every applied fix was independently re-verified against the working tree before committing.
  • Deliberately excluded: subjective suggestions, preferences not explicitly required by the style guides, anything requiring interpretation, and anything whose validation would require changes outside the window's diff. Auto-generated artifacts (error databases, namespace data tables, REPL help data, regenerated equation SVGs) were treated as out of scope.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of 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 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

claude added 3 commits July 19, 2026 12:24
…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
@stdlib-bot stdlib-bot added the BLAS Issue or pull request related to Basic Linear Algebra Subprograms (BLAS). label Jul 19, 2026
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
blas/base/ndarray/dsyr2 $\\color{green}156/156$
$\\color{green}+100.00\\%$
$\\color{green}3/3$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}156/156$
$\\color{green}+100.00\\%$
blas/base/ndarray/ssyr2 $\\color{green}156/156$
$\\color{green}+100.00\\%$
$\\color{green}3/3$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}156/156$
$\\color{green}+100.00\\%$
blas/ext/base/ndarray/gany $\\color{green}105/105$
$\\color{green}+100.00\\%$
$\\color{green}3/3$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}105/105$
$\\color{green}+100.00\\%$

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

@kgryte
kgryte marked this pull request as ready for review July 19, 2026 20:03
@kgryte
kgryte requested a review from a team July 19, 2026 20:03
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jul 19, 2026
@kgryte kgryte removed the Needs Review A pull request which needs code review. label Jul 19, 2026
@kgryte kgryte changed the title fix: apply follow-up fixes for blas/base/ndarray/dsyr2, blas/base/ndarray/ssyr2, and blas/ext/base/ndarray/gany chore: clean-up Jul 19, 2026
@kgryte
kgryte merged commit 2b91bfe into develop Jul 19, 2026
55 checks passed
@kgryte
kgryte deleted the philipp/fix-commit-review-2026-07-19 branch July 19, 2026 20:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

BLAS Issue or pull request related to Basic Linear Algebra Subprograms (BLAS).

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants