Skip to content

Commit d793db6

Browse files
committed
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: na - 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 c2fa56c commit d793db6

File tree

1 file changed

+5
-5
lines changed
  • lib/node_modules/@stdlib/blas/base/icamax/docs/types

1 file changed

+5
-5
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ interface Routine {
3131
*
3232
* @param N - number of indexed elements
3333
* @param x - input array
34-
* @param stride - stride length for `x`
34+
* @param strideX - stride length for `x`
3535
* @returns index value
3636
*
3737
* @example
@@ -42,14 +42,14 @@ interface Routine {
4242
* var idx = icamax( x.length, x, 1 );
4343
* // returns 1
4444
*/
45-
( N: number, x: Complex64Array, stride: number ): number;
45+
( N: number, x: Complex64Array, strideX: number ): number;
4646

4747
/**
4848
* Finds the index of the first element having maximum |Re(.)| + |Im(.)| using alternative indexing semantics.
4949
*
5050
* @param N - number of indexed elements
5151
* @param x - input array
52-
* @param stride - stride length for `x`
52+
* @param strideX - stride length for `x`
5353
* @param offset - starting index for `x`
5454
* @returns index value
5555
*
@@ -61,15 +61,15 @@ interface Routine {
6161
* var idx = icamax.ndarray( x.length, x, 1, 0 );
6262
* // returns 1
6363
*/
64-
ndarray( N: number, x: Complex64Array, stride: number, offset: number ): number;
64+
ndarray( N: number, x: Complex64Array, strideX: number, offset: number ): number;
6565
}
6666

6767
/**
6868
* Finds the index of the first element having maximum |Re(.)| + |Im(.)|
6969
*
7070
* @param N - number of indexed elements
7171
* @param x - input array
72-
* @param stride - stride length for `x`
72+
* @param strideX - stride length for `x`
7373
* @returns index value
7474
*
7575
* @example

0 commit comments

Comments
 (0)