Skip to content

Commit 21e06db

Browse files
Shabareesh ShettyShabareesh Shetty
authored andcommitted
docs: update jsdoc
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 85f32fa commit 21e06db

File tree

5 files changed

+15
-15
lines changed

5 files changed

+15
-15
lines changed

lib/node_modules/@stdlib/blas/base/zaxpy/docs/types/index.d.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ interface Routine {
3333
* @param N - number of indexed elements
3434
* @param alpha - scalar constant
3535
* @param x - first input array
36-
* @param strideX - `x` stride length
36+
* @param strideX - stride length for `x`
3737
* @param y - second input array
38-
* @param strideY - `y` stride length
38+
* @param strideY - stride length for `y`
3939
* @returns second input array
4040
*
4141
* @example
@@ -52,15 +52,15 @@ interface Routine {
5252
( N: number, alpha: Complex128, x: Complex128Array, strideX: number, y: Complex128Array, strideY: number ): Complex128Array;
5353

5454
/**
55-
* Scales a double-precision complex floating-point vector by a double-precision complex floating-point constant and adds the result to a double-precision complex floating-point vector.
55+
* Scales a double-precision complex floating-point vector by a double-precision complex floating-point constant and adds the result to a double-precision complex floating-point vector using alternative indexing semantics.
5656
*
5757
* @param N - number of indexed elements
5858
* @param alpha - scalar constant
5959
* @param x - first input array
60-
* @param strideX - `x` stride length
60+
* @param strideX - stride length for `x`
6161
* @param offsetX - starting index for `x`
6262
* @param y - second input array
63-
* @param strideY - `y` stride length
63+
* @param strideY - stride length for `y`
6464
* @param offsetY - starting index for `y`
6565
* @returns second input array
6666
*
@@ -84,9 +84,9 @@ interface Routine {
8484
* @param N - number of indexed elements
8585
* @param alpha - scalar constant
8686
* @param x - first input array
87-
* @param strideX - `x` stride length
87+
* @param strideX - stride length for `x`
8888
* @param y - second input array
89-
* @param strideY - `y` stride length
89+
* @param strideY - stride length for `y`
9090
* @returns second input array
9191
*
9292
* @example

lib/node_modules/@stdlib/blas/base/zaxpy/lib/ndarray.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ var dcabs1 = require( '@stdlib/blas/base/dcabs1' );
3535
* @param {PositiveInteger} N - number of indexed elements
3636
* @param {Complex128} alpha - scalar constant
3737
* @param {Complex128Array} x - first input array
38-
* @param {integer} strideX - `x` stride length
38+
* @param {integer} strideX - stride length for `x`
3939
* @param {integer} offsetX - starting index for `x`
4040
* @param {Complex128Array} y - second input array
41-
* @param {integer} strideY - `y` stride length
41+
* @param {integer} strideY - stride length for `y`
4242
* @param {integer} offsetY - starting index for `y`
4343
* @returns {Complex128Array} second input array
4444
*

lib/node_modules/@stdlib/blas/base/zaxpy/lib/ndarray.native.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ var addon = require( './../src/addon.node' );
3333
* @param {PositiveInteger} N - number of indexed elements
3434
* @param {Complex128} alpha - scalar constant
3535
* @param {Complex128Array} x - first input array
36-
* @param {integer} strideX - `x` stride length
36+
* @param {integer} strideX - stride length for `x`
3737
* @param {integer} offsetX - starting index for `x`
3838
* @param {Complex128Array} y - second input array
39-
* @param {integer} strideY - `y` stride length
39+
* @param {integer} strideY - stride length for `y`
4040
* @param {integer} offsetY - starting index for `y`
4141
* @returns {Complex128Array} second input array
4242
*

lib/node_modules/@stdlib/blas/base/zaxpy/lib/zaxpy.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ var ndarray = require( './ndarray.js' );
3232
* @param {PositiveInteger} N - number of indexed elements
3333
* @param {Complex128} alpha - scalar constant
3434
* @param {Complex128Array} x - first input array
35-
* @param {integer} strideX - `x` stride length
35+
* @param {integer} strideX - stride length for `x`
3636
* @param {Complex128Array} y - second input array
37-
* @param {integer} strideY - `y` stride length
37+
* @param {integer} strideY - stride length for `y`
3838
* @returns {Complex128Array} second input array
3939
*
4040
* @example

lib/node_modules/@stdlib/blas/base/zaxpy/lib/zaxpy.native.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ var addon = require( './../src/addon.node' );
3333
* @param {PositiveInteger} N - number of indexed elements
3434
* @param {Complex128} alpha - scalar constant
3535
* @param {Complex128Array} x - first input array
36-
* @param {integer} strideX - `x` stride length
36+
* @param {integer} strideX - stride length for `x`
3737
* @param {Complex128Array} y - second input array
38-
* @param {integer} strideY - `y` stride length
38+
* @param {integer} strideY - stride length for `y`
3939
* @returns {Complex128Array} second input array
4040
*
4141
* @example

0 commit comments

Comments
 (0)