Skip to content

Commit 4ebbd97

Browse files
committed
docs: fix TypeScript declarations doctest lint errors
--- 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 bac835d commit 4ebbd97

File tree

5 files changed

+16
-16
lines changed

5 files changed

+16
-16
lines changed

lib/node_modules/@stdlib/lapack/base/claset/docs/types/index.d.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ interface Routine {
5151
* var beta = new Complex64( 3.0, 4.0 );
5252
*
5353
* claset( 'row-major', 'all', 2, 2, alpha, beta, A, 2 );
54-
* // A => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 3.0, 4.0, 1.0, 2.0 ]
54+
* // A => <Complex64Array>[ 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
5555
*/
5656
( order: Layout, uplo: string, M: number, N: number, alpha: Complex64, beta: Complex64, A: Complex64Array, LDA: number ): Complex64Array;
5757

@@ -79,7 +79,7 @@ interface Routine {
7979
* var beta = new Complex64( 3.0, 4.0 );
8080
*
8181
* claset.ndarray( 'all', 2, 2, alpha, beta, A, 2, 1, 0 );
82-
* // A => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 3.0, 4.0, 1.0, 2.0 ]
82+
* // A => <Complex64Array>[ 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
8383
*/
8484
ndarray( uplo: string, M: number, N: number, alpha: Complex64, beta: Complex64, A: Complex64Array, strideA1: number, strideA2: number, offsetA: number ): Complex64Array;
8585
}
@@ -106,7 +106,7 @@ interface Routine {
106106
* var beta = new Complex64( 3.0, 4.0 );
107107
*
108108
* claset( 'row-major', 'all', 2, 2, alpha, beta, A, 2 );
109-
* // A => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 3.0, 4.0, 1.0, 2.0 ]
109+
* // A => <Complex64Array>[ 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
110110
*
111111
* @example
112112
* var Complex64Array = require( '@stdlib/array/complex64' );
@@ -116,8 +116,8 @@ interface Routine {
116116
* var alpha = new Complex64( 1.0, 2.0 );
117117
* var beta = new Complex64( 3.0, 4.0 );
118118
*
119-
* claset.ndarray( 'all', 2, 2, A, 2, 1, 1 );
120-
* // A => <Complex64Array>[ 0.0, 0.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0, 1.0, 2.0 ]
119+
* claset.ndarray( 'all', 2, 2, alpha, beta, A, 2, 1, 1 );
120+
* // A => <Complex64Array>[ 0.0, 0.0, 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
121121
*/
122122
declare var claset: Routine;
123123

lib/node_modules/@stdlib/lapack/base/dlarf1f/docs/types/index.d.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ interface Routine {
6262
* var V = new Float64Array( [ 0.5, 0.5, 0.5, 0.5 ] );
6363
* var work = new Float64Array( 3 );
6464
*
65-
* dlarf1f( 'row-major', 'left', 4, 3, V, 1, 1.0, C, 3, work );
65+
* var out = dlarf1f( 'row-major', 'left', 4, 3, V, 1, 1.0, C, 3, work );
6666
* // returns <Float64Array>[ -4.5, -10.5, -16.5, -0.75, -1.75, -2.75, 0.25, -0.75, -1.75, 1.25, 0.25, -0.75 ]
6767
*/
6868
( order: Layout, side: OperationSide, M: number, N: number, V: Float64Array, strideV: number, tau: number, C: Float64Array, ldc: number, work: Float64Array ): Float64Array;
@@ -107,7 +107,7 @@ interface Routine {
107107
* var V = new Float64Array( [ 0.5, 0.5, 0.5, 0.5 ] );
108108
* var work = new Float64Array( 3 );
109109
*
110-
* dlarf1f.ndarray( 'left', 4, 3, V, 1, 0, 1.0, C, 3, 1, 0, work, 1, 0 );
110+
* var out = dlarf1f.ndarray( 'left', 4, 3, V, 1, 0, 1.0, C, 3, 1, 0, work, 1, 0 );
111111
* // returns <Float64Array>[ -4.5, -10.5, -16.5, -0.75, -1.75, -2.75, 0.25, -0.75, -1.75, 1.25, 0.25, -0.75 ]
112112
*/
113113
ndarray( side: OperationSide, M: number, N: number, V: Float64Array, strideV: number, offsetV: number, tau: number, C: Float64Array, strideC1: number, strideC2: number, offsetC: number, work: Float64Array, strideWork: number, offsetWork: number ): Float64Array;
@@ -149,7 +149,7 @@ interface Routine {
149149
* var V = new Float64Array( [ 0.5, 0.5, 0.5, 0.5 ] );
150150
* var work = new Float64Array( 3 );
151151
*
152-
* dlarf1f( 'row-major', 'left', 4, 3, V, 1, 1.0, C, 3, work );
152+
* var out = dlarf1f( 'row-major', 'left', 4, 3, V, 1, 1.0, C, 3, work );
153153
* // returns <Float64Array>[ -4.5, -10.5, -16.5, -0.75, -1.75, -2.75, 0.25, -0.75, -1.75, 1.25, 0.25, -0.75 ]
154154
*
155155
* @example
@@ -159,7 +159,7 @@ interface Routine {
159159
* var V = new Float64Array( [ 0.5, 0.5, 0.5, 0.5 ] );
160160
* var work = new Float64Array( 3 );
161161
*
162-
* dlarf1f.ndarray( 'left', 4, 3, V, 1, 0, 1.0, C, 3, 1, 0, work, 1, 0 );
162+
* var out = dlarf1f.ndarray( 'left', 4, 3, V, 1, 0, 1.0, C, 3, 1, 0, work, 1, 0 );
163163
* // returns <Float64Array>[ -4.5, -10.5, -16.5, -0.75, -1.75, -2.75, 0.25, -0.75, -1.75, 1.25, 0.25, -0.75 ]
164164
*/
165165
declare var dlarf1f: Routine;

lib/node_modules/@stdlib/lapack/base/zlaset/docs/types/index.d.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ interface Routine {
5151
* var beta = new Complex128( 3.0, 4.0 );
5252
*
5353
* zlaset( 'row-major', 'all', 2, 2, alpha, beta, A, 2 );
54-
* // A => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 3.0, 4.0, 1.0, 2.0 ]
54+
* // A => <Complex128Array>[ 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
5555
*/
5656
( order: Layout, uplo: string, M: number, N: number, alpha: Complex128, beta: Complex128, A: Complex128Array, LDA: number ): Complex128Array;
5757

@@ -79,7 +79,7 @@ interface Routine {
7979
* var beta = new Complex128( 3.0, 4.0 );
8080
*
8181
* zlaset.ndarray( 'all', 2, 2, alpha, beta, A, 2, 1, 0 );
82-
* // A => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 3.0, 4.0, 1.0, 2.0 ]
82+
* // A => <Complex128Array>[ 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
8383
*/
8484
ndarray( uplo: string, M: number, N: number, alpha: Complex128, beta: Complex128, A: Complex128Array, strideA1: number, strideA2: number, offsetA: number ): Complex128Array;
8585
}
@@ -106,7 +106,7 @@ interface Routine {
106106
* var beta = new Complex128( 3.0, 4.0 );
107107
*
108108
* zlaset( 'row-major', 'all', 2, 2, alpha, beta, A, 2 );
109-
* // A => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 3.0, 4.0, 1.0, 2.0 ]
109+
* // A => <Complex128Array>[ 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
110110
*
111111
* @example
112112
* var Complex128Array = require( '@stdlib/array/complex128' );
@@ -116,8 +116,8 @@ interface Routine {
116116
* var alpha = new Complex128( 1.0, 2.0 );
117117
* var beta = new Complex128( 3.0, 4.0 );
118118
*
119-
* zlaset.ndarray( 'all', 2, 2, A, 2, 1, 1 );
120-
* // A => <Complex128Array>[ 0.0, 0.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0, 1.0, 2.0 ]
119+
* zlaset.ndarray( 'all', 2, 2, alpha, beta, A, 2, 1, 1 );
120+
* // A => <Complex128Array>[ 0.0, 0.0, 3.0, 4.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0 ]
121121
*/
122122
declare var zlaset: Routine;
123123

lib/node_modules/@stdlib/utils/flatten-object/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ interface FlattenObject {
121121
* var obj = {'a':{'b':{'c':'d'}}};
122122
*
123123
* var out = flatten( obj );
124-
* // returns {'a|b':{'c':'d'}}
124+
* // returns {'a|b|c':'d'}
125125
*/
126126
declare var flattenObject: FlattenObject;
127127

lib/node_modules/@stdlib/utils/parse-ndjson/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
* @returns array of parsed values or an error
2727
*
2828
* @example
29-
* var arr = parseNDJSON( '{"beep":"boop"}\\n{"example":42}\\n{"data":[1,2,3]}' );
29+
* var arr = parseNDJSON( '{"beep":"boop"}\n{"example":42}\n{"data":[1,2,3]}' );
3030
* // returns [ { 'beep': 'boop' }, { 'example': 42 }, { 'data': [ 1, 2, 3 ] } ]
3131
*/
3232

0 commit comments

Comments
 (0)