Skip to content

docs: correct documentation wording in three blas/base/wasm packages #14363

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

Draft
Planeshifter wants to merge 3 commits into
base: develop
Choose a base branch
from
+11 −11
Draft

docs: correct documentation wording in three blas/base/wasm packages #14363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6555bda
docs: fix JSDoc summary for `blas/base/wasm/scasum`
claude Aug 18, 2026
3516729
docs: hyphenate "floating-point" in `blas/base/wasm/dswap`
claude Aug 18, 2026
213b993
docs: hyphenate "floating-point" in `blas/base/wasm/sswap`
claude Aug 18, 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
10 changes: 5 additions & 5 deletions lib/node_modules/@stdlib/blas/base/wasm/dswap/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ limitations under the License.

# dswap

> Interchange two double-precision floating point vectors.
> Interchange two double-precision floating-point vectors.

<section class="usage">

Expand All @@ -32,7 +32,7 @@ var dswap = require( '@stdlib/blas/base/wasm/dswap' );

#### dswap.main( N, x, strideX, y, strideY )

Interchanges two double-precision floating point vectors.
Interchanges two double-precision floating-point vectors.

```javascript
var Float64Array = require( '@stdlib/array/float64' );
Expand Down Expand Up @@ -86,7 +86,7 @@ dswap.main( 3, x1, -2, y1, 1 );

#### dswap.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )

Interchanges two double-precision floating point vectors using alternative indexing semantics.
Interchanges two double-precision floating-point vectors using alternative indexing semantics.

```javascript
var Float64Array = require( '@stdlib/array/float64' );
Expand Down Expand Up @@ -146,7 +146,7 @@ mod.initializeSync();

#### dswap.Module.prototype.main( N, xp, sx, yp, sy )

Interchanges two double-precision floating point vectors.
Interchanges two double-precision floating-point vectors.

<!-- eslint-disable n/no-sync -->

Expand Down Expand Up @@ -210,7 +210,7 @@ The function has the following parameters:

#### dswap.Module.prototype.ndarray( N, xp, sx, ox, yp, sy, oy )

Interchanges two double-precision floating point vectors using alternative indexing semantics.
Interchanges two double-precision floating-point vectors using alternative indexing semantics.

<!-- eslint-disable n/no-sync -->

Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/blas/base/wasm/scasum/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@

var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
var Routine = require( './routine.js' );
var Module = require( './module.js' );

Check warning on line 25 in lib/node_modules/@stdlib/blas/base/wasm/scasum/lib/main.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

only the `bind` property of the required module is used; require the property directly


// MAIN //

/**
* WebAssembly module compute the sum of the absolute values of the real and imaginary components of a single-precision complex floating-point vector.
* WebAssembly module to compute the sum of the absolute values of the real and imaginary components of a single-precision complex floating-point vector.
*
* @name scasum
* @type {Routine}
Expand Down
10 changes: 5 additions & 5 deletions lib/node_modules/@stdlib/blas/base/wasm/sswap/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ limitations under the License.

# sswap

> Interchange two single-precision floating point vectors.
> Interchange two single-precision floating-point vectors.

<section class="usage">

Expand All @@ -32,7 +32,7 @@ var sswap = require( '@stdlib/blas/base/wasm/sswap' );

#### sswap.main( N, x, strideX, y, strideY )

Interchanges two single-precision floating point vectors.
Interchanges two single-precision floating-point vectors.

```javascript
var Float32Array = require( '@stdlib/array/float32' );
Expand Down Expand Up @@ -86,7 +86,7 @@ sswap.main( 3, x1, -2, y1, 1 );

#### sswap.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )

Interchanges two single-precision floating point vectors using alternative indexing semantics.
Interchanges two single-precision floating-point vectors using alternative indexing semantics.

```javascript
var Float32Array = require( '@stdlib/array/float32' );
Expand Down Expand Up @@ -146,7 +146,7 @@ mod.initializeSync();

#### sswap.Module.prototype.main( N, xp, sx, yp, sy )

Interchanges two single-precision floating point vectors.
Interchanges two single-precision floating-point vectors.

<!-- eslint-disable n/no-sync -->

Expand Down Expand Up @@ -210,7 +210,7 @@ The function has the following parameters:

#### sswap.Module.prototype.ndarray( N, xp, sx, ox, yp, sy, oy )

Interchanges two single-precision floating point vectors using alternative indexing semantics.
Interchanges two single-precision floating-point vectors using alternative indexing semantics.

<!-- eslint-disable n/no-sync -->

Expand Down