Skip to content

docs: update descriptions and example #13059

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 2 commits into from
Jun 23, 2026
Merged

docs: update descriptions and example #13059

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b006fb5
docs: clarify ndarray dimensionality in `blas/ext/base/ndarray/{d,s}a…
claude Jun 22, 2026
d9851ce
chore: update example variable name in `constants/float32/e`
claude Jun 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/blas/ext/base/ndarray/daxpby/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
'use strict';

/**
* Multiply a double-precision floating-point ndarray by a scalar constant and add the result to a second double-precision floating-point ndarray multiplied by a scalar constant.
* Multiply a one-dimensional double-precision floating-point ndarray by a scalar constant and add the result to a second one-dimensional double-precision floating-point ndarray multiplied by a scalar constant.
*
* @module @stdlib/blas/ext/base/ndarray/daxpby
*
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/blas/ext/base/ndarray/daxpby/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ var ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' );
// MAIN //

/**
* Multiplies a double-precision floating-point ndarray by a scalar constant and adds the result to a second double-precision floating-point ndarray multiplied by a scalar constant.
* Multiplies a one-dimensional double-precision floating-point ndarray by a scalar constant and adds the result to a second one-dimensional double-precision floating-point ndarray multiplied by a scalar constant.
*
* ## Notes
*
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/blas/ext/base/ndarray/daxpby/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@stdlib/blas/ext/base/ndarray/daxpby",
"version": "0.0.0",
"description": "Multiply a double-precision floating-point ndarray by a scalar constant and add the result to a second double-precision floating-point ndarray multiplied by a scalar constant.",
"description": "Multiply a one-dimensional double-precision floating-point ndarray by a scalar constant and add the result to a second one-dimensional double-precision floating-point ndarray multiplied by a scalar constant.",
"license": "Apache-2.0",
"author": {
"name": "The Stdlib Authors",
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
'use strict';

/**
* Multiply a single-precision floating-point ndarray by a scalar constant and add the result to a second single-precision floating-point ndarray multiplied by a scalar constant.
* Multiply a one-dimensional single-precision floating-point ndarray by a scalar constant and add the result to a second one-dimensional single-precision floating-point ndarray multiplied by a scalar constant.
*
* @module @stdlib/blas/ext/base/ndarray/saxpby
*
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ var ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' );
// MAIN //

/**
* Multiplies a single-precision floating-point ndarray by a scalar constant and adds the result to a second single-precision floating-point ndarray multiplied by a scalar constant.
* Multiplies a one-dimensional single-precision floating-point ndarray by a scalar constant and adds the result to a second one-dimensional single-precision floating-point ndarray multiplied by a scalar constant.
*
* ## Notes
*
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@stdlib/blas/ext/base/ndarray/saxpby",
"version": "0.0.0",
"description": "Multiply a single-precision floating-point ndarray by a scalar constant and add the result to a second single-precision floating-point ndarray multiplied by a scalar constant.",
"description": "Multiply a one-dimensional single-precision floating-point ndarray by a scalar constant and add the result to a second one-dimensional single-precision floating-point ndarray multiplied by a scalar constant.",
"license": "Apache-2.0",
"author": {
"name": "The Stdlib Authors",
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/constants/float32/e/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
* @type {number}
*
* @example
* var E = require( '@stdlib/constants/float32/e' );
* var FLOAT32_E = require( '@stdlib/constants/float32/e' );
* // returns 2.7182817459106445
*/

Expand Down