Skip to content

Commit 47088cc

Browse files
PlaneshifterPlaneshifter
committed
docs: fix TSDoc comments example code and return annotation values
--- 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 e0b955f commit 47088cc

File tree

33 files changed

+100
-100
lines changed

33 files changed

+100
-100
lines changed

‎lib/node_modules/@stdlib/array/base/cuany-by-right/docs/types/index.d.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ interface CuanyByRight {
157157
* var y = [ false, null, false, null, false, null, false, null, false, null ];
158158
*
159159
* var arr = cuanyByRight.assign( x, y, 2, 0, isPositive );
160-
* // returns [ false, null, false, null, false, null, true, null, true, null ]
160+
* // returns [ false, null, ..., true, null ]
161161
*/
162162
assign<T = unknown, U = unknown, V = unknown>( x: Collection<T> | AccessorArrayLike<T>, out: Collection<U> | AccessorArrayLike<U>, stride: number, offset: number, predicate: Predicate<T, V>, thisArg?: ThisParameterType<Predicate<T, V>> ): Collection<U | boolean> | AccessorArrayLike<U | boolean>;
163163
}
@@ -187,7 +187,7 @@ interface CuanyByRight {
187187
* var y = [ false, null, false, null, false, null, false, null, false, null ];
188188
*
189189
* var arr = cuanyByRight.assign( x, y, 2, 0, isPositive );
190-
* // returns [ false, null, false, null, false, null, true, null, true, null ]
190+
* // returns [ false, null, ..., true, null ]
191191
*/
192192
declare var cuanyByRight: CuanyByRight;
193193

‎lib/node_modules/@stdlib/array/base/resolve-setter/docs/types/index.d.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -201,16 +201,16 @@ declare function resolveSetter( x: Float32Array ): SetFloat32;
201201
* var resolveGetter = require( '@stdlib/array/base/resolve-getter' );
202202
* var Complex128Array = require( '@stdlib/array/complex128' );
203203
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
204-
* var real = require( '@stdlib/array/real' );
205-
* var imag = require( '@stdlib/array/imag' );
204+
* var real = require( '@stdlib/complex/float64/real' );
205+
* var imag = require( '@stdlib/complex/float64/imag' );
206206
*
207207
* var arr = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
208208
*
209209
* var set = resolveSetter( arr );
210210
* set( arr, 1, new Complex128( 10.0, 11.0 ) );
211211
*
212212
* var get = resolveGetter( arr );
213-
* var v = get( arr, 2 );
213+
* var v = get( arr, 1 );
214214
* // returns <Complex128>
215215
*
216216
* var re = real( v );
@@ -231,16 +231,16 @@ declare function resolveSetter( x: Complex128Array ): SetComplex128;
231231
* var resolveGetter = require( '@stdlib/array/base/resolve-getter' );
232232
* var Complex64Array = require( '@stdlib/array/complex64' );
233233
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
234-
* var realf = require( '@stdlib/array/realf' );
235-
* var imagf = require( '@stdlib/array/imagf' );
234+
* var realf = require( '@stdlib/complex/float32/real' );
235+
* var imagf = require( '@stdlib/complex/float32/imag' );
236236
*
237237
* var arr = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
238238
*
239239
* var set = resolveSetter( arr );
240240
* set( arr, 1, new Complex64( 10.0, 11.0 ) );
241241
*
242242
* var get = resolveGetter( arr );
243-
* var v = get( arr, 2 );
243+
* var v = get( arr, 1 );
244244
* // returns <Complex64>
245245
*
246246
* var re = realf( v );

‎lib/node_modules/@stdlib/array/from-iterator/docs/types/index.d.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ declare function iterator2array<T = unknown, U = unknown, W = unknown>( iterator
118118
*
119119
* var out = new Float64Array( 10 );
120120
* var arr = iterator2array( iter, out );
121-
* // returns <Array>
121+
* // returns <Float64Array>
122122
*/
123123
declare function iterator2array<T = unknown, U = unknown>( iterator: Iterator<T>, out: Collection<U> ): Collection<T | U>;
124124

@@ -145,7 +145,7 @@ declare function iterator2array<T = unknown, U = unknown>( iterator: Iterator<T>
145145
*
146146
* var out = new Float64Array( 10 );
147147
* var arr = iterator2array( iter, out, scale );
148-
* // returns <Array>
148+
* // returns <Float64Array>
149149
*/
150150
declare function iterator2array<T = unknown, U = unknown, V = unknown, W = unknown>( iterator: Iterator<T>, out: Collection<V>, mapFcn: MapFunction<T, U, W>, thisArg?: ThisParameterType<MapFunction<T, U, W>> ): Collection<U | V>;
151151

‎lib/node_modules/@stdlib/array/from-scalar/docs/types/index.d.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ declare function scalar2array( value: number, dtype: 'uint8' ): Uint8Array;
191191
*
192192
* @example
193193
* var x = scalar2array( 1, 'uint8c' );
194-
* // returns <Uint8ClampedArray>[]
194+
* // returns <Uint8ClampedArray>[ 1 ]
195195
*/
196196
declare function scalar2array( value: number, dtype: 'uint8c' ): Uint8ClampedArray;
197197

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ interface Routine {
4040
* var x = new Complex64Array( [ 0.3, 0.1, 0.5, 0.0, 0.0, 0.5, 0.0, 0.2, 2.0, 3.0 ] );
4141
*
4242
* var out = scasum( 5, x, 1 );
43-
* // returns ~6.9
43+
* // returns ~6.6
4444
*/
4545
( N: number, x: Complex64Array, strideX: number ): number;
4646

@@ -59,7 +59,7 @@ interface Routine {
5959
* var x = new Complex64Array( [ 0.3, 0.1, 0.5, 0.0, 0.0, 0.5, 0.0, 0.2, 2.0, 3.0 ] );
6060
*
6161
* var out = scasum.ndarray( 5, x, 1, 0 );
62-
* // returns ~6.9
62+
* // returns ~6.6
6363
*/
6464
ndarray( N: number, x: Complex64Array, strideX: number, offsetX: number ): number;
6565
}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ interface Routine {
6767
* var y = new Float32Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
6868
*
6969
* srot.ndarray( 3, x, 2, 1, y, 2, 1, 0.8, 0.6 );
70-
* // x => <Float32Array>[ 1.0, 6.4, 3.0, 9.2, 5.0, 12.0 ]
70+
* // x => <Float32Array>[ 1.0, ~6.4, 3.0, ~9.2, 5.0, 12.0 ]
7171
* // y => <Float32Array>[ 7.0, 5.2, 9.0, 5.6, 11.0, ~6.0 ]
7272
*/
7373
ndarray( N: number, x: Float32Array, strideX: number, offsetX: number, y: Float32Array, strideY: number, offsetY: number, c: number, s: number ): Float32Array;
@@ -92,7 +92,7 @@ interface Routine {
9292
* var y = new Float32Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
9393
*
9494
* srot( 3, x, 2, y, 2, 0.8, 0.6 );
95-
* // x => <Float32Array>[ 5.0, 2.0, ~7.8, 4.0, ~10.6, 6.0 ]
95+
* // x => <Float32Array>[ ~5.0, 2.0, ~7.8, 4.0, ~10.6, 6.0 ]
9696
* // y => <Float32Array>[ 5.0, 8.0, ~5.4, 10.0, ~5.8, 12.0 ]
9797
*
9898
* @example

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ interface Routine {
3737
* var x = new Float64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
3838
*
3939
* dfill( x.length, 5.0, x, 1 );
40-
* // x => <Float64Array>[ 5.0, 5.0, 5.0, 0.0, 5.0, 5.0, 5.0, 5.0 ]
40+
* // x => <Float64Array>[ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ]
4141
*/
4242
( N: number, alpha: number, x: Float64Array, strideX: number ): Float64Array;
4343

@@ -57,7 +57,7 @@ interface Routine {
5757
* var x = new Float64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
5858
*
5959
* dfill.ndarray( x.length, 5.0, x, 1, 0 );
60-
* // x => <Float64Array>[ 5.0, 5.0, 5.0, 0.0, 5.0, 5.0, 5.0, 5.0 ]
60+
* // x => <Float64Array>[ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ]
6161
*/
6262
ndarray( N: number, alpha: number, x: Float64Array, strideX: number, offsetX: number ): Float64Array;
6363
}
@@ -77,15 +77,15 @@ interface Routine {
7777
* var x = new Float64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
7878
*
7979
* dfill( x.length, 5.0, x, 1 );
80-
* // x => <Float64Array>[ 5.0, 5.0, 5.0, 0.0, 5.0, 5.0, 5.0, 5.0 ]
80+
* // x => <Float64Array>[ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ]
8181
*
8282
* @example
8383
* var Float64Array = require( '@stdlib/array/float64' );
8484
*
8585
* var x = new Float64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
8686
*
8787
* dfill.ndarray( x.length, 5.0, x, 1, 0 );
88-
* // x => <Float64Array>[ 5.0, 5.0, 5.0, 0.0, 5.0, 5.0, 5.0, 5.0 ]
88+
* // x => <Float64Array>[ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ]
8989
*/
9090
declare var dfill: Routine;
9191

‎lib/node_modules/@stdlib/blas/ext/base/gfill-by/docs/types/index.d.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ interface Routine {
111111
* }
112112
*
113113
* gfillBy( x.length, x, 1, fill );
114-
* // x => [ 5.0, 5.0, 5.0, 0.0, 5.0, 5.0, 5.0, 5.0 ]
114+
* // x => [ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ]
115115
*/
116116
<T = unknown, U = unknown, V = unknown, W = unknown>( N: number, x: Collection<V>, strideX: number, clbk: Callback<T, U, V, W>, thisArg?: ThisParameterType<Callback<T, U, V, W>> ): Collection<U | V>;
117117

@@ -145,7 +145,7 @@ interface Routine {
145145
* }
146146
*
147147
* gfillBy.ndarray( x.length, x, 1, 0, fill );
148-
* // x => [ 5.0, 5.0, 5.0, 0.0, 5.0, 5.0, 5.0, 5.0 ]
148+
* // x => [ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ]
149149
*/
150150
ndarray<T = unknown, U = unknown, V = unknown, W = unknown>( N: number, x: Collection<V>, strideX: number, offsetX: number, clbk: Callback<T, U, V, W>, thisArg?: ThisParameterType<Callback<T, U, V, W>> ): Collection<U | V>;
151151
}
@@ -179,7 +179,7 @@ interface Routine {
179179
* }
180180
*
181181
* gfillBy( x.length, x, 1, fill );
182-
* // x => [ 5.0, 5.0, 5.0, 0.0, 5.0, 5.0, 5.0, 5.0 ]
182+
* // x => [ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ]
183183
*
184184
* @example
185185
* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];
@@ -189,7 +189,7 @@ interface Routine {
189189
* }
190190
*
191191
* gfillBy.ndarray( x.length, x, 1, 0, fill );
192-
* // x => [ 5.0, 5.0, 5.0, 0.0, 5.0, 5.0, 5.0, 5.0 ]
192+
* // x => [ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ]
193193
*/
194194
declare var gfillBy: Routine;
195195

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ interface Routine {
4141
* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];
4242
*
4343
* gfill( x.length, 5.0, toAccessorArray( x ), 1 );
44-
* // x => [ 5.0, 5.0, 5.0, 0.0, 5.0, 5.0, 5.0, 5.0 ]
44+
* // x => [ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ]
4545
*/
4646
<T = unknown, U = unknown>( N: number, alpha: T, x: AccessorArrayLike<U>, strideX: number ): AccessorArrayLike<T | U>;
4747

@@ -58,7 +58,7 @@ interface Routine {
5858
* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];
5959
*
6060
* gfill( x.length, 5.0, x, 1 );
61-
* // x => [ 5.0, 5.0, 5.0, 0.0, 5.0, 5.0, 5.0, 5.0 ]
61+
* // x => [ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ]
6262
*/
6363
<T = unknown, U = unknown>( N: number, alpha: T, x: Collection<U>, strideX: number ): Collection<T | U>;
6464

@@ -78,7 +78,7 @@ interface Routine {
7878
* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];
7979
*
8080
* gfill.ndarray( x.length, 5.0, toAccessorArray( x ), 1, 0 );
81-
* // x => [ 5.0, 5.0, 5.0, 0.0, 5.0, 5.0, 5.0, 5.0 ]
81+
* // x => [ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ]
8282
*/
8383
ndarray<T = unknown, U = unknown>( N: number, alpha: T, x: AccessorArrayLike<U>, strideX: number, offsetX: number ): AccessorArrayLike<T | U>;
8484

@@ -96,7 +96,7 @@ interface Routine {
9696
* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];
9797
*
9898
* gfill.ndarray( x.length, 5.0, x, 1, 0 );
99-
* // x => [ 5.0, 5.0, 5.0, 0.0, 5.0, 5.0, 5.0, 5.0 ]
99+
* // x => [ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ]
100100
*/
101101
ndarray<T = unknown, U = unknown>( N: number, alpha: T, x: Collection<U>, strideX: number, offsetX: number ): Collection<T | U>;
102102
}
@@ -114,13 +114,13 @@ interface Routine {
114114
* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];
115115
*
116116
* gfill( x.length, 5.0, x, 1 );
117-
* // x => [ 5.0, 5.0, 5.0, 0.0, 5.0, 5.0, 5.0, 5.0 ]
117+
* // x => [ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ]
118118
*
119119
* @example
120120
* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];
121121
*
122122
* gfill.ndarray( x.length, 5.0, x, 1, 0 );
123-
* // x => [ 5.0, 5.0, 5.0, 0.0, 5.0, 5.0, 5.0, 5.0 ]
123+
* // x => [ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ]
124124
*/
125125
declare var gfill: Routine;
126126

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ interface Routine {
3737
* var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
3838
*
3939
* sfill( x.length, 5.0, x, 1 );
40-
* // x => <Float32Array>[ 5.0, 5.0, 5.0, 0.0, 5.0, 5.0, 5.0, 5.0 ]
40+
* // x => <Float32Array>[ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ]
4141
*/
4242
( N: number, alpha: number, x: Float32Array, strideX: number ): Float32Array;
4343

@@ -57,7 +57,7 @@ interface Routine {
5757
* var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
5858
*
5959
* sfill.ndarray( x.length, 5.0, x, 1, 0 );
60-
* // x => <Float32Array>[ 5.0, 5.0, 5.0, 0.0, 5.0, 5.0, 5.0, 5.0 ]
60+
* // x => <Float32Array>[ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ]
6161
*/
6262
ndarray( N: number, alpha: number, x: Float32Array, strideX: number, offsetX: number ): Float32Array;
6363
}
@@ -77,15 +77,15 @@ interface Routine {
7777
* var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
7878
*
7979
* sfill( x.length, 5.0, x, 1 );
80-
* // x => <Float32Array>[ 5.0, 5.0, 5.0, 0.0, 5.0, 5.0, 5.0, 5.0 ]
80+
* // x => <Float32Array>[ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ]
8181
*
8282
* @example
8383
* var Float32Array = require( '@stdlib/array/float32' );
8484
*
8585
* var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
8686
*
8787
* sfill.ndarray( x.length, 5.0, x, 1, 0 );
88-
* // x => <Float32Array>[ 5.0, 5.0, 5.0, 0.0, 5.0, 5.0, 5.0, 5.0 ]
88+
* // x => <Float32Array>[ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ]
8989
*/
9090
declare var sfill: Routine;
9191

0 commit comments

Comments
 (0)