From 8dd35163035ce77e6744d773666b9f91f989683e Mon Sep 17 00:00:00 2001 From: Claude Date: Sun, 19 Jul 2026 12:24:37 +0000 Subject: [PATCH 1/3] fix: correct declaration tests and documentation for `blas/base/ndarray/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 --- lib/node_modules/@stdlib/blas/base/ndarray/dsyr2/README.md | 2 +- .../@stdlib/blas/base/ndarray/dsyr2/docs/types/test.ts | 4 ++-- lib/node_modules/@stdlib/blas/base/ndarray/dsyr2/lib/main.js | 1 + lib/node_modules/@stdlib/blas/base/ndarray/dsyr2/package.json | 2 +- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dsyr2/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/dsyr2/README.md index f10399799e6c..48f937a7fb11 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dsyr2/README.md +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dsyr2/README.md @@ -20,7 +20,7 @@ limitations under the License. # dsyr2 -> Performs the symmetric rank 2 operation `A = alpha*x*y^T + alpha*y*x^T + A`. +> Perform the symmetric rank 2 operation `A = alpha*x*y^T + alpha*y*x^T + A`.
diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dsyr2/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/ndarray/dsyr2/docs/types/test.ts index e6fce2e8e2f0..f599943dac15 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dsyr2/docs/types/test.ts +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dsyr2/docs/types/test.ts @@ -42,7 +42,7 @@ import dsyr2 = require( '@stdlib/blas/base/ndarray/dsyr2' ); 'dtype': 'float64' }); - dsyr2( [ A, x, y, uplo, alpha ] ); // $ExpectType float64ndarray + dsyr2( [ x, y, A, uplo, alpha ] ); // $ExpectType float64ndarray } // The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... @@ -77,5 +77,5 @@ import dsyr2 = require( '@stdlib/blas/base/ndarray/dsyr2' ); }); dsyr2(); // $ExpectError - dsyr2( [ A, x, y, uplo, alpha ], {} ); // $ExpectError + dsyr2( [ x, y, A, uplo, alpha ], {} ); // $ExpectError } diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dsyr2/lib/main.js b/lib/node_modules/@stdlib/blas/base/ndarray/dsyr2/lib/main.js index 7b02605fa000..67c36d3d9fe9 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dsyr2/lib/main.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dsyr2/lib/main.js @@ -47,6 +47,7 @@ var strided = require( '@stdlib/blas/base/dsyr2' ).ndarray; * @param {ArrayLikeObject} arrays - array-like object containing ndarrays * @returns {Object} output ndarray * +* @example * var Float64Matrix = require( '@stdlib/ndarray/matrix/float64' ); * var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); * var resolveEnum = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' ); diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dsyr2/package.json b/lib/node_modules/@stdlib/blas/base/ndarray/dsyr2/package.json index 681561d7c668..60a1123518dd 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dsyr2/package.json +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dsyr2/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/blas/base/ndarray/dsyr2", "version": "0.0.0", - "description": "Performs the symmetric rank 2 operation `A = alpha*x*y^T + alpha*y*x^T + A`.", + "description": "Perform the symmetric rank 2 operation `A = alpha*x*y^T + alpha*y*x^T + A`.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", From 4bd89d4ab03ea5d6fa273490d3003a20c4901466 Mon Sep 17 00:00:00 2001 From: Claude Date: Sun, 19 Jul 2026 12:24:44 +0000 Subject: [PATCH 2/3] docs: fix JSDoc example tag and descriptions for `blas/base/ndarray/ssyr2` - add missing JSDoc `@example` tag in `lib/main.js` - use imperative mood in README tagline and `package.json` description to match sibling packages --- lib/node_modules/@stdlib/blas/base/ndarray/ssyr2/README.md | 2 +- lib/node_modules/@stdlib/blas/base/ndarray/ssyr2/lib/main.js | 1 + lib/node_modules/@stdlib/blas/base/ndarray/ssyr2/package.json | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/ssyr2/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/ssyr2/README.md index 6738169d3b69..3e36df0c3dd0 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/ssyr2/README.md +++ b/lib/node_modules/@stdlib/blas/base/ndarray/ssyr2/README.md @@ -20,7 +20,7 @@ limitations under the License. # ssyr2 -> Performs the symmetric rank 2 operation `A = alpha*x*y^T + alpha*y*x^T + A`. +> Perform the symmetric rank 2 operation `A = alpha*x*y^T + alpha*y*x^T + A`.
diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/ssyr2/lib/main.js b/lib/node_modules/@stdlib/blas/base/ndarray/ssyr2/lib/main.js index c6337100f091..842451782acc 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/ssyr2/lib/main.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/ssyr2/lib/main.js @@ -47,6 +47,7 @@ var strided = require( '@stdlib/blas/base/ssyr2' ).ndarray; * @param {ArrayLikeObject} arrays - array-like object containing ndarrays * @returns {Object} output ndarray * +* @example * var Float32Matrix = require( '@stdlib/ndarray/matrix/float32' ); * var Float32Vector = require( '@stdlib/ndarray/vector/float32' ); * var resolveEnum = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' ); diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/ssyr2/package.json b/lib/node_modules/@stdlib/blas/base/ndarray/ssyr2/package.json index 50528550dfc9..094a63371320 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/ssyr2/package.json +++ b/lib/node_modules/@stdlib/blas/base/ndarray/ssyr2/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/blas/base/ndarray/ssyr2", "version": "0.0.0", - "description": "Performs the symmetric rank 2 operation `A = alpha*x*y^T + alpha*y*x^T + A`.", + "description": "Perform the symmetric rank 2 operation `A = alpha*x*y^T + alpha*y*x^T + A`.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", From 503809cbe8e018a7d14c8802a18d441997854ff3 Mon Sep 17 00:00:00 2001 From: Claude Date: Sun, 19 Jul 2026 12:24:44 +0000 Subject: [PATCH 3/3] docs: update parameter description and TypeScript declaration for `blas/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` in the TypeScript declaration to match the convention of generic ndarray routines in the same directory --- lib/node_modules/@stdlib/blas/ext/base/ndarray/gany/README.md | 4 +--- .../@stdlib/blas/ext/base/ndarray/gany/docs/types/index.d.ts | 4 ++-- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gany/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gany/README.md index 93224365e357..efac896ae8b6 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gany/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gany/README.md @@ -51,9 +51,7 @@ var v = gany( [ x ] ); The function has the following parameters: -- **arrays**: array-like object containing the following ndarrays: - - - a one-dimensional input ndarray. +- **arrays**: array-like object containing a one-dimensional input ndarray. diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gany/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gany/docs/types/index.d.ts index 4a27c4cd4e99..f7fdba5b75bc 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gany/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gany/docs/types/index.d.ts @@ -20,7 +20,7 @@ /// -import { ndarray } from '@stdlib/types/ndarray'; +import { typedndarray } from '@stdlib/types/ndarray'; /** * Tests whether at least one element in a one-dimensional ndarray is truthy. @@ -44,7 +44,7 @@ import { ndarray } from '@stdlib/types/ndarray'; * var v = gany( [ x ] ); * // returns true */ -declare function gany( arrays: [ ndarray ] ): boolean; +declare function gany( arrays: [ typedndarray ] ): boolean; // EXPORTS //