Skip to content

Commit d94514b

Browse files
committed
docs: clean-up TSDoc declaration comments
--- 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: passed - task: lint_license_headers status: passed ---
1 parent 07459d3 commit d94514b

File tree

15 files changed

+26
-24
lines changed

15 files changed

+26
-24
lines changed

lib/node_modules/@stdlib/array/empty-like/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ declare function emptyLike( x: Array<any> ): Array<number>;
5959
* var zeros = require( '@stdlib/array/zeros' );
6060
*
6161
* var x = zeros( 2, 'float64' );
62-
* // returns <Float32Array>[ 0.0, 0.0 ]
62+
* // returns <Float64Array>[ 0.0, 0.0 ]
6363
*
6464
* var arr = emptyLike( x, 'float32' );
6565
* // returns <Float32Array>
@@ -83,7 +83,7 @@ declare function emptyLike<T extends TypedArray | ComplexTypedArray | BooleanTyp
8383
* var zeros = require( '@stdlib/array/zeros' );
8484
*
8585
* var x = zeros( 2, 'float64' );
86-
* // returns <Float32Array>[ 0.0, 0.0 ]
86+
* // returns <Float64Array>[ 0.0, 0.0 ]
8787
*
8888
* var arr = emptyLike( x, 'float32' );
8989
* // returns <Float32Array>

lib/node_modules/@stdlib/array/typed-complex/docs/types/index.d.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,14 @@ declare function complexarray<T extends keyof DataTypeMap = 'complex128'>( lengt
6666
* @returns complex number typed array
6767
*
6868
* @example
69+
* var Complex128Array = require( '@stdlib/array/complex128' );
70+
*
6971
* var arr = complexarray( new Complex128Array( 2 ) );
7072
* // returns <Complex128Array>
7173
*
7274
* @example
75+
* var Complex128Array = require( '@stdlib/array/complex128' );
76+
*
7377
* var arr = complexarray( new Complex128Array( 2 ), 'complex64' );
7478
* // returns <Complex64Array>
7579
*/

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ interface Routine {
4545
* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
4646
*
4747
* dspr( 'row-major', 'upper', 3, 1.0, x, 1, AP );
48-
* // A => <Float64Array>[ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ]
48+
* // AP => <Float64Array>[ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ]
4949
*/
5050
( order: Layout, uplo: MatrixTriangle, N: number, alpha: number, x: Float64Array, strideX: number, AP: Float64Array ): Float64Array;
5151

@@ -71,7 +71,7 @@ interface Routine {
7171
* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
7272
*
7373
* dspr.ndarray( 'row-major', 'upper', 3, 1.0, x, 1, 0, AP, 1, 0 );
74-
* // A => <Float64Array>[ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ]
74+
* // AP => <Float64Array>[ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ]
7575
*/
7676
ndarray( order: Layout, uplo: MatrixTriangle, N: number, alpha: number, x: Float64Array, strideX: number, offsetX: number, AP: Float64Array, strideAP: number, offsetAP: number ): Float64Array;
7777
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ interface Routine {
7373
* var A = new Float64Array( [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ] ); // => [ [ 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0 ], [ 0.0, 0.0, 1.0 ] ]
7474
* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
7575
*
76-
* dtrsv.ndarray( 'row-major', 'upper', 'no-transpose', 'unit', 3, A, 3, 1, 0, x, 1, 0 );
76+
* dtrsv.ndarray( 'lower', 'no-transpose', 'unit', 3, A, 3, 1, 0, x, 1, 0 );
7777
* // x => <Float64Array>[ 0.0, -4.0, 3.0 ]
7878
*/
7979
ndarray( uplo: MatrixTriangle, trans: TransposeOperation, diag: DiagonalType, N: number, A: Float64Array, strideA1: number, strideA2: number, offsetA: number, x: Float64Array, strideX: number, offsetX: number ): Float64Array;

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ interface Routine {
7373
* var A = new Float32Array( [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ] ); // => [ [ 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0 ], [ 0.0, 0.0, 1.0 ] ]
7474
* var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
7575
*
76-
* strsv.ndarray( 'row-major', 'upper', 'no-transpose', 'unit', 3, A, 3, 1, 0, x, 1, 0 );
76+
* strsv.ndarray( 'lower', 'no-transpose', 'unit', 3, A, 3, 1, 0, x, 1, 0 );
7777
* // x => <Float32Array>[ 0.0, -4.0, 3.0 ]
7878
*/
7979
ndarray( uplo: MatrixTriangle, trans: TransposeOperation, diag: DiagonalType, N: number, A: Float32Array, strideA1: number, strideA2: number, offsetA: number, x: Float32Array, strideX: number, offsetX: number ): Float32Array;

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ interface Routine {
6161
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
6262
* var out = new Float64Array( 2 );
6363
*
64-
* var v = dnannsum( x.length, x, 1, 0, out, 1, 0 );
64+
* var v = dnannsum.ndarray( x.length, x, 1, 0, out, 1, 0 );
6565
* // returns <Float64Array>[ 1.0, 3 ]
6666
*/
6767
ndarray( N: number, x: Float64Array, strideX: number, offsetX: number, out: Float64Array, strideOut: number, offsetOut: number ): Float64Array;
@@ -92,7 +92,7 @@ interface Routine {
9292
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
9393
* var out = new Float64Array( 2 );
9494
*
95-
* var v = dnannsum( x.length, x, 1, 0, out, 1, 0 );
95+
* var v = dnannsum.ndarray( x.length, x, 1, 0, out, 1, 0 );
9696
* // returns <Float64Array>[ 1.0, 3 ]
9797
*/
9898
declare var dnannsum: Routine;

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ interface Routine {
6161
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
6262
* var out = new Float64Array( 2 );
6363
*
64-
* var v = dnannsumkbn( x.length, x, 1, 0, out, 1, 0 );
64+
* var v = dnannsumkbn.ndarray( x.length, x, 1, 0, out, 1, 0 );
6565
* // returns <Float64Array>[ 1.0, 3 ]
6666
*/
6767
ndarray( N: number, x: Float64Array, strideX: number, offsetX: number, out: Float64Array, strideOut: number, offsetOut: number ): Float64Array;

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ interface Routine {
6161
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
6262
* var out = new Float64Array( 2 );
6363
*
64-
* var v = dnannsumkbn2( x.length, x, 1, 0, out, 1, 0 );
64+
* var v = dnannsumkbn2.ndarray( x.length, x, 1, 0, out, 1, 0 );
6565
* // returns <Float64Array>[ 1.0, 3 ]
6666
*/
6767
ndarray( N: number, x: Float64Array, strideX: number, offsetX: number, out: Float64Array, strideOut: number, offsetOut: number ): Float64Array;
@@ -92,7 +92,7 @@ interface Routine {
9292
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
9393
* var out = new Float64Array( 2 );
9494
*
95-
* var v = dnannsumkbn2( x.length, x, 1, 0, out, 1, 0 );
95+
* var v = dnannsumkbn2.ndarray( x.length, x, 1, 0, out, 1, 0 );
9696
* // returns <Float64Array>[ 1.0, 3 ]
9797
*/
9898
declare var dnannsumkbn2: Routine;

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ interface Routine {
6161
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
6262
* var out = new Float64Array( 2 );
6363
*
64-
* var v = dnannsumors( x.length, x, 1, 0, out, 1, 0 );
64+
* var v = dnannsumors.ndarray( x.length, x, 1, 0, out, 1, 0 );
6565
* // returns <Float64Array>[ 1.0, 3 ]
6666
*/
6767
ndarray( N: number, x: Float64Array, strideX: number, offsetX: number, out: Float64Array, strideOut: number, offsetOut: number ): Float64Array;
@@ -92,7 +92,7 @@ interface Routine {
9292
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
9393
* var out = new Float64Array( 2 );
9494
*
95-
* var v = dnannsumors( x.length, x, 1, 0, out, 1, 0 );
95+
* var v = dnannsumors.ndarray( x.length, x, 1, 0, out, 1, 0 );
9696
* // returns <Float64Array>[ 1.0, 3 ]
9797
*/
9898
declare var dnannsumors: Routine;

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ interface Routine {
6161
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
6262
* var out = new Float64Array( 2 );
6363
*
64-
* var v = dnannsumpw( x.length, x, 1, 0, out, 1, 0 );
64+
* var v = dnannsumpw.ndarray( x.length, x, 1, 0, out, 1, 0 );
6565
* // returns <Float64Array>[ 1.0, 3 ]
6666
*/
6767
ndarray( N: number, x: Float64Array, strideX: number, offsetX: number, out: Float64Array, strideOut: number, offsetOut: number ): Float64Array;
@@ -92,7 +92,7 @@ interface Routine {
9292
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
9393
* var out = new Float64Array( 2 );
9494
*
95-
* var v = dnannsumpw( x.length, x, 1, 0, out, 1, 0 );
95+
* var v = dnannsumpw.ndarray( x.length, x, 1, 0, out, 1, 0 );
9696
* // returns <Float64Array>[ 1.0, 3 ]
9797
*/
9898
declare var dnannsumpw: Routine;

0 commit comments

Comments
 (0)